Skip to content

Commit 7204540

Browse files
authored
[connector/spanmetrics] - Explictly mark the field as deprecated (open-telemetry#41101)
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue. Ex. Adding a feature - Explain what this achieves.--> #### Description The field `dimensions_cache_size` was marked as deprecated without the version information. We should follow upstream guidlines for [deprecations](https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/coding-guidelines.md#api-breaking-changes). And, then remove this field in next version.
1 parent f901f2c commit 7204540

File tree

2 files changed

+28
-1
lines changed

2 files changed

+28
-1
lines changed
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Use this changelog template to create an entry for release notes.
2+
3+
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
4+
change_type: deprecation
5+
6+
# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
7+
component: spanmetricsconnector
8+
9+
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
10+
note: Mark dimensions_cache_size as deprecated following the upstream guidelines
11+
12+
# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
13+
issues: [41101]
14+
15+
# (Optional) One or more lines of additional information to render under the primary note.
16+
# These lines will be padded with 2 spaces and then inserted directly into the document.
17+
# Use pipe (|) for multiline entries.
18+
subtext:
19+
20+
# If your change doesn't affect end users or the exported elements of any package,
21+
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
22+
# Optional: The change log or logs in which this entry should be included.
23+
# e.g. '[user]' or '[user, api]'
24+
# Include 'user' if the change is relevant to end users.
25+
# Include 'api' if there is a change to a library API.
26+
# Default: '[user]'
27+
change_logs: [user]

connector/spanmetricsconnector/config.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ type Config struct {
4949
// DimensionsCacheSize defines the size of cache for storing Dimensions, which helps to avoid cache memory growing
5050
// indefinitely over the lifetime of the collector.
5151
// Optional. See defaultDimensionsCacheSize in connector.go for the default value.
52-
// Deprecated: Please use AggregationCardinalityLimit instead
52+
// Deprecated [v0.130.0]: Please use AggregationCardinalityLimit instead
5353
DimensionsCacheSize int `mapstructure:"dimensions_cache_size"`
5454

5555
// ResourceMetricsCacheSize defines the size of the cache holding metrics for a service. This is mostly relevant for

0 commit comments

Comments
 (0)