Update JSDoc for types.ts for PrometheusExporter #6191
+3
−1
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which problem is this PR solving?
The JSDoc for the
ExporterConfig.appendTimestampconfiguration option in the Prometheus exporter incorrectly states that the default value istrue.However, the actual implementation in
PrometheusExporter.tsexplicitly defines the default asfalseinstatic readonly DEFAULT_OPTIONS:https://github.com/open-telemetry/opentelemetry-js/blob/main/experimental/packages/opentelemetry-exporter-prometheus/src/PrometheusExporter.ts#L31
This PR resolves the inconsistency to prevent user confusion—something I initially experienced when reading the JS sources and .d.ts files.
Short description of the changes
experimental/packages/opentelemetry-exporter-prometheus/src/export/types.tsto reflect that@defaultisfalse.Type of change
How Has This Been Tested?
This is a documentation-only change (JSDoc fix) and does not alter runtime behavior. I verified the default value by inspecting the source code in
PrometheusExporter.tsandPrometheusSerializer.ts.Checklist: