/agent-config

Config for hypertrace agents

Primary LanguageGoApache License 2.0Apache-2.0

Build Status

Agent Config

Agent config contains the configuration specs for the Hypertrace agents.

Configs can be set through config file, environment variables or code. For a list of supported environment variables have a look at this list.

Conventions

In order to make sure compatibility across languages and versions, the following conventions must be followed:

  • All messages and fields should include a comment, describing what the field describes and/or the effect on a certain value, e.g. "when false, permits connecting to the trace endpoint without a certificate".
  • Fields must not be removed, if there is a need to deprecate a config settings, the field should be marked as deprecated.
  • Fields should not depend on each others, every field should be independent and self contained to avoid config logic in the libraries.
  • Time duration fields should include a suffix indicating the time unit e.g. retryIntervalSeconds.
  • Config must not be modified in runtime by the user through code.

Contributing

Before submitting a PR, make sure you run the linter:

protolint config.proto

Initialize the git submodules before generating the env vars.

git submodule update  --init  --recursive