To develop OTelBin locally, you will need to clone this repository and set up all the env vars outlined in the .env.example file.
Once that's done, you can use the following commands to run the app locally:
cd packages/otelbin
npm i
npm run dev
This repository uses a JSON schema from the VS Code's extension OTEL Validator in order to provide validation for the collector configuration file.
To get the latest schema version, either clone the repository and copy the schema from assets/schema.json or directly download the file from the nimbushq/otel-validator repository.
To update the JSON schema for this project, follow these steps:
- Familiarize Yourself with JSON Schema:
- Read through the official JSON Schema documentation to understand its structure and rules.
- Review the Upstream Repository:
- Visit the OpenTelemetry official website, OpenTelemetry Collector github repository and OpenTelemetry Contrib GitHub repository to explore the latest changes and properties that need to be reflected in the JSON schema.
- Identify Missing Properties:
- Examine the Go files, READMEs, or other relevant sources in the mentioned sources to identify properties and configurations that are not yet included in the JSON schema.
- Update the Schema:
- Make changes to the JSON schema file in your forked repository based on the properties and configurations you've identified. You can use a JSON schema editor or a text editor to make these updates.
- Test Your Changes:
- Ensure that your updated JSON schema is valid by using JSON schema validation tools. This will help catch any syntax or structural issues in your schema.
- Commit and Push:
- Commit your changes to the JSON schema file in your forked repository.
- Create a Pull Request:
- Visit your forked repository on GitHub and create a pull request (PR) to merge your changes into the main repository's JSON schema.
See the dedicated documentation.