Skip to content

Commit 9b16f91

Browse files
mhlidddevflow.devflow-routing-intake
andauthored
Update configuration documentation for clarity (#11966)
Update configuration documentation for clarity Clarified instructions for introducing new configurations and noted auto-generated version in the Feature Parity Dashboard. Co-authored-by: devflow.devflow-routing-intake <devflow.devflow-routing-intake@kubernetes.us1.ddbuild.io>
1 parent 8f323b5 commit 9b16f91

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

docs/add_new_configurations.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ In order to properly add a new configuration in the library, follow the below st
3636
1. The key is the Environment Variable name, and the value is an array of objects with the following fields:
3737
1. Version.
3838
1. If introducing a new configuration, provide a version of `A`.
39-
2. If the configuration already exists in the Feature Parity Dashboard and has the same implementation details as an existing Configuration Version, add the version listed on the Feature Parity Dashboard. Else, introduce a new Configuration Version, fill in the proper documentation, and use the version provided.
39+
2. If the configuration already exists in the Feature Parity Dashboard and has the same implementation details as an existing Configuration Version, add the version listed on the Feature Parity Dashboard. Else, follow Step 8 to introduce a new configuration implementation and use the new auto-generated version.
4040
2. Type. This is a _mandatory_ field and has the options of boolean, int, decimal, string, map, array. If the configuration is eventually converted to an Enum or other class, use type String.
4141
3. Default. This is a _mandatory_ field and accepts null as a valid value.
4242
4. Aliases. This is a _mandatory_ field. If there are no aliases for the configuration, use an empty array as the value.
@@ -69,7 +69,7 @@ See below for an example of the `supported-configurations.json` file.
6969
}
7070
}
7171
```
72-
8. If the configuration is unique to all tracing libraries, add it to the [Feature Parity Dashboard](https://feature-parity.us1.prod.dog/#/configurations?viewType=configurations). This ensures that we have good documentation of all configurations supported in the library.
72+
8. If the configuration is unique to all tracing libraries, add it to the [Feature Parity Dashboard](https://feature-parity.us1.prod.dog/#/configurations?viewType=configurations). This ensures that we have good documentation of all configurations supported in the library. Note that the `version` is auto-generated by the FPD.
7373

7474
For details on adding environment variables to `metadata/supported-configurations.json` or the Feature Parity Dashboard, refer to this [document](https://datadoghq.atlassian.net/wiki/spaces/APMINT/pages/5372248222/APM+-+Centralized+Configuration+Config+inversion#dd-trace-java).
7575

0 commit comments

Comments
 (0)