docs(internal_metrics source): Add note about making metrics unique (v…

…ectordotdev#12975) Prompted by vectordotdev#12958 (comment) Signed-off-by: Jesse Szwedko <[email protected]>
numbnut · Jun 6, 2022 · 88fc15a · 88fc15a
1 parent a04bdf3
commit 88fc15a
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/website/cue/reference/components/sources/internal_metrics.cue b/website/cue/reference/components/sources/internal_metrics.cue
@@ -1265,6 +1265,21 @@ components: sources: internal_metrics: {
 		}
 	}
 
+	how_it_works: {
+		unique_series: {
+			title: "Sending metrics from multiple Vector instances"
+			body: """
+				When sending `internal_metrics` from multiple Vector instances
+				to the same destination, you will typically want to tag the
+				metrics with a tag that is unique to the Vector instance sending
+				the metrics to avoid the metric series conflicting. The
+				`tags.host_key` option can be used for this, but you can also
+				use a subsequent `remap` transform to add a different unique
+				tag from the environment.
+				"""
+		}
+	}
+
 	telemetry: metrics: {
 		component_discarded_events_total:     components.sources.internal_metrics.output.metrics.component_discarded_events_total
 		component_errors_total:               components.sources.internal_metrics.output.metrics.component_errors_total