chore(observability)!: remove deprecated component_name metric tag (#…

…18942) * chore(datadog)!: remove deprecated config options * update cue and add upgrade guide * Update website/content/en/highlights/2023-11-07-0-34-0-upgrade-guide.md Co-authored-by: Jesse Szwedko <[email protected]> * chore(observability)!: remove deprecated `component_name` metric tag * remove remaining references --------- Co-authored-by: Jesse Szwedko <[email protected]>
vectordotdev · Oct 30, 2023 · 0305584 · 0305584
1 parent 266e1ca
commit 0305584
Show file tree

Hide file tree

Showing 6 changed files with 6 additions and 24 deletions.
diff --git a/lib/vector-core/src/metrics/label_filter.rs b/lib/vector-core/src/metrics/label_filter.rs
@@ -10,7 +10,6 @@ impl LabelFilter for VectorLabelFilter {
         key == "component_id"
             || key == "component_type"
             || key == "component_kind"
-            || key == "component_name"
             || key == "buffer_type"
     }
 }
diff --git a/src/config/source.rs b/src/config/source.rs
@@ -181,7 +181,7 @@ impl SourceContext {
         if config.enabled() {
             warn!(
                 message = "Enabling `acknowledgements` on sources themselves is deprecated in favor of enabling them in the sink configuration, and will be removed in a future version.",
-                component_name = self.key.id(),
+                component_id = self.key.id(),
             );
         }
 

diff --git a/src/topology/builder.rs b/src/topology/builder.rs
@@ -228,8 +228,6 @@ impl<'a> Builder<'a> {
                 component_kind = "source",
                 component_id = %key.id(),
                 component_type = %source.inner.get_component_name(),
-                // maintained for compatibility
-                component_name = %key.id(),
             );
             let _entered_span = span.enter();
 
@@ -437,8 +435,6 @@ impl<'a> Builder<'a> {
                 component_kind = "transform",
                 component_id = %key.id(),
                 component_type = %transform.inner.get_component_name(),
-                // maintained for compatibility
-                component_name = %key.id(),
             );
 
             // Create a map of the outputs to the list of possible definitions from those outputs.
@@ -523,8 +519,6 @@ impl<'a> Builder<'a> {
                 component_kind = "sink",
                 component_id = %key.id(),
                 component_type = %sink.inner.get_component_name(),
-                // maintained for compatibility
-                component_name = %key.id(),
             );
             let _entered_span = span.enter();
 
@@ -643,8 +637,6 @@ impl<'a> Builder<'a> {
                                     component_kind = "sink",
                                     component_type = typetag,
                                     component_id = %component_key.id(),
-                                    // maintained for compatibility
-                                    component_name = %component_key.id(),
                                 );
                                 Err(TaskError::wrapped(error))
                             }
@@ -654,8 +646,6 @@ impl<'a> Builder<'a> {
                                     component_kind = "sink",
                                     component_type = typetag,
                                     component_id = %component_key.id(),
-                                    // maintained for compatibility
-                                    component_name = %component_key.id(),
                                 );
                                 Err(TaskError::wrapped(Box::new(e)))
                             }

diff --git a/src/topology/running.rs b/src/topology/running.rs
@@ -833,8 +833,6 @@ impl RunningTopology {
             component_kind = "sink",
             component_id = %task.id(),
             component_type = %task.typetag(),
-            // maintained for compatibility
-            component_name = %task.id(),
         );
 
         let task_span = span.or_current();
@@ -876,8 +874,6 @@ impl RunningTopology {
             component_kind = "transform",
             component_id = %task.id(),
             component_type = %task.typetag(),
-            // maintained for compatibility
-            component_name = %task.id(),
         );
 
         let task_span = span.or_current();
@@ -919,8 +915,6 @@ impl RunningTopology {
             component_kind = "source",
             component_id = %task.id(),
             component_type = %task.typetag(),
-            // maintained for compatibility
-            component_name = %task.id(),
         );
 
         let task_span = span.or_current();

diff --git a/website/content/en/highlights/2023-11-07-0-34-0-upgrade-guide.md b/website/content/en/highlights/2023-11-07-0-34-0-upgrade-guide.md
@@ -12,6 +12,7 @@ badges:
 Vector's 0.34.0 release includes **breaking changes**:
 
 1. [Removal of Deprecated Datadog Component Config Options](#datadog-deprecated-config-options)
+1. [Removal of Deprecated `component_name` Metric Tag](#deprecated-component-name)
 
 We cover them below to help you upgrade quickly:
 
@@ -26,3 +27,7 @@ and Metrics sinks. Instead the `site` option should be used.
 
 The `region` and `application_key` config options have
 been removed from the Enterprise configuration. Instead of `region`, `site` should be used. `application_key` is no longer required.
+
+#### Removal of Deprecated `component_name` Metric Tag {#deprecated-component-name}
+
+The deprecated `component_name` tag has been removed from all internal metrics. Instead the `component_id` tag should be used.
diff --git a/website/cue/reference/components/sources/internal_metrics.cue b/website/cue/reference/components/sources/internal_metrics.cue
@@ -1094,7 +1094,6 @@ components: sources: internal_metrics: {
 		_component_tags: _internal_metrics_tags & {
 			component_kind: _component_kind
 			component_id:   _component_id
-			component_name: _component_name
 			component_type: _component_type
 		}
 
@@ -1117,11 +1116,6 @@ components: sources: internal_metrics: {
 			required:    true
 			examples: ["my_source", "my_sink"]
 		}
-		_component_name: {
-			description: "Deprecated, use `component_id` instead. The value is the same as `component_id`."
-			required:    true
-			examples: ["my_source", "my_sink"]
-		}
 		_component_type: {
 			description: "The Vector component type."
 			required:    true