metrics_mapping.go

package docs

// MetricsMappingFieldSpec is a field spec that describes a Bloblang mapping for
// renaming metrics.
func MetricsMappingFieldSpec(name string) FieldSpec {
	examples := []any{
		`this.replace("input", "source").replace("output", "sink")`,
		`root = if ![
  "input_received",
  "input_latency",
  "output_sent"
].contains(this) { deleted() }`,
	}
	summary := "An optional [Bloblang mapping](/docs/guides/bloblang/about) that allows you to rename or prevent certain metrics paths from being exported. For more information check out the [metrics documentation](/docs/components/metrics/about#metric-mapping). When metric paths are created, renamed and dropped a trace log is written, enabling TRACE level logging is therefore a good way to diagnose path mappings."
	return FieldBloblang(name, summary, examples...).HasDefault("")
}