文档 Grafana Alloy 参考 组件 otelcol otelcol.exporter.splunkhec

社区

otelcol.exporter.splunkhec

社区：此组件由 Alloy 用户社区开发、维护和支持。Grafana 不为此组件提供商业支持。要启用和使用社区组件，您必须将 --feature.community-components.enabled flag 设置为 true。

otelcol.exporter.splunkhec 接受来自其他 otelcol 组件的指标和跟踪遥测数据，并将其发送到 Splunk HEC。

您可以通过为 otelcol.exporter.splunkhec 组件赋予不同的标签来指定多个组件。

用法

alloy 复制

otelcol.exporter.splunkhec "LABEL" {
    splunk {
        token = "YOUR_SPLUNK_TOKEN"
    }
    client {
        endpoint = "http://splunk.yourdomain.com:8088"
    }
}

参数

otelcol.exporter.splunkhec 组件不支持任何参数，并且完全通过子块进行配置。

块

在 otelcol.exporter.splunkhec 的定义中支持以下块

splunk 块

splunk 块配置 Splunk HEC 的特定设置。

支持以下参数

otel_to_hec_fields 块

heartbeat 块

telemetry 块

batcher 块

client 块

client 块配置组件使用的 HTTP 客户端。

支持以下参数

retry_on_failure 块

retry_on_failure 块配置如何重试 splunkhec 的失败请求。

支持以下参数

当 enabled 为 true 时，失败的批次会在给定的间隔后重试。initial_interval 参数指定在第一次重试尝试之前等待多长时间。如果请求继续失败，则重试之前等待的时间会按 multiplier 参数指定的因子增加，该因子必须大于 1.0。max_interval 参数指定重试之间等待时间上限。

randomization_factor 参数对于在重试 Alloy 实例之间添加抖动很有用。如果 randomization_factor 大于 0，则重试前的等待时间将乘以范围 [I - randomization_factor * I, I + randomization_factor * I] 中的随机因子，其中 I 是当前间隔。

如果批次未成功发送，则在 max_elapsed_time 指定的时间过去后会被丢弃。如果 max_elapsed_time 设置为 `"0s"`，则将永远重试失败的请求，直到成功为止。

queue 块

queue 块配置在将数据发送到 HTTP 服务器之前批次的内存缓冲区。

支持以下参数

当 enabled 为 true 时，数据首先写入内存缓冲区，然后再发送到配置的服务器。发送到组件 input 导出字段的批次会添加到缓冲区，只要未发送批次的数量不超过配置的 queue_size。

queue_size 决定了端点中断可以容忍多长时间。假设每秒 100 个请求，默认队列大小 1000 提供大约 10 秒的中断容忍度。要计算 queue_size 的正确值，请将每秒平均传出请求数乘以可以容忍中断的时间（秒）。非常高的值可能会导致内存不足 (OOM) 终止。

num_consumers 参数控制有多少读取器从缓冲区读取并并行发送数据。num_consumers 的值越大，数据发送速度越快，但会增加网络流量。

debug_metrics 块

debug_metrics 块配置此组件生成的用于监控其状态的指标。

支持以下参数

disable_high_cardinality_metrics 是 Grafana Alloy 中与 OpenTelemetry Collector 中的 telemetry.disableHighCardinalityMetrics 功能门等效的项。它会删除可能导致高基数指标的属性。例如，删除了 HTTP 和 gRPC 连接指标中带有 IP 地址和端口号的属性。

level 是 Alloy 中与 OpenTelemetry Collector 中的 telemetry.metrics.level 功能门等效的项。可能的值为 `"none"`、"basic"`、"normal"` 和 "detailed"`。

导出字段

以下字段已导出，可以被其他组件引用

input 接受任何遥测信号（指标、日志或跟踪）的 otelcol.Consumer 数据。

组件健康状况

仅当给定无效配置时，otelcol.exporter.splunkhec 才会被报告为不健康。

Debug 信息

otelcol.exporter.splunkhec 不公开任何组件特定的 debug 信息。

示例

OpenTelemetry 接收器

此示例将发送到 otelcol.receiver.otlp.default 接收器的指标、日志和跟踪转发到 Splunk HEC 导出器。

复制

otelcol.receiver.otlp "default" {
	grpc {
		endpoint = "localhost:4317"
	}

	http {
		endpoint               = "localhost:4318"
		compression_algorithms = ["zlib"]
	}

	output {
		metrics = [otelcol.exporter.splunkhec.default.input]
		logs    = [otelcol.exporter.splunkhec.default.input]
		traces  = [otelcol.exporter.splunkhec.default.input]
	}
}

otelcol.exporter.splunkhec "default" {
	client {
		endpoint                = "https://splunkhec.domain.com:8088/services/collector"
		timeout                 = "10s"
		max_idle_conns          = 200
		max_idle_conns_per_host = 200
		idle_conn_timeout       = "10s"
	}

	splunk {
		token              = "SPLUNK_TOKEN"
		source             = "otel"
		sourcetype         = "otel"
		index              = "metrics"
		splunk_app_name    = "OpenTelemetry-Collector Splunk Exporter"
		splunk_app_version = "v0.0.1"
z
		otel_to_hec_fields {
			severity_text   = "otel.log.severity.text"
			severity_number = "otel.log.severity.number"
		}

		heartbeat {
			interval = "30s"
		}

		telemetry {
			enabled                = true
			override_metrics_names = {
				otelcol_exporter_splunkhec_heartbeats_failed = "app_heartbeats_failed_total",
				otelcol_exporter_splunkhec_heartbeats_sent   = "app_heartbeats_success_total",
			}
			extra_attributes = {
				custom_key   = "custom_value",
				dataset_name = "SplunkCloudBeaverStack",
			}
		}
	}
}

转发 Prometheus 指标

此示例通过接收器从 Alloy 转发 Prometheus 指标，以转换为 OpenTelemetry 格式，然后再将其发送到 splunkhec。

alloy 复制

prometheus.exporter.self "default" {
}

prometheus.scrape "metamonitoring" {
  targets    = prometheus.exporter.self.default.targets
  forward_to = [otelcol.receiver.prometheus.default.receiver]
}

otelcol.receiver.prometheus "default" {
  output {
    metrics = [otelcol.exporter.splunkhec.default.input]
  }
}


otelcol.exporter.splunkhec "default" {
    splunk {
        token = "SPLUNK_TOKEN"
    }
    client {
        endpoint = "http://splunkhec.domain.com:8088"
    }
}

转发 Loki 日志

此示例监视路径 /var/log 中以 .log 结尾的文件，使用 Loki 跟踪这些日志，并将日志转发到配置的 Splunk HEC 端点。Splunk HEC 导出器组件设置为每 5 秒发送一次心跳。

alloy 复制

local.file_match "local_files" {
	path_targets = [{"__path__" = "/var/log/*.log"}]
	sync_period  = "5s"
}

otelcol.receiver.loki "default" {
	output {
		logs = [otelcol.processor.attributes.default.input]
	}
}

otelcol.processor.attributes "default" {
	action {
		key    = "host"
		action = "upsert"
		value  = "myhost"
	}

	action {
		key    = "host.name"
		action = "upsert"
		value  = "myhost"
	}

	output {
		logs = [otelcol.exporter.splunkhec.default.input]
	}
}

loki.source.file "log_scrape" {
	targets       = local.file_match.local_files.targets
	forward_to    = [otelcol.receiver.loki.default.receiver]
	tail_from_end = false
}

otelcol.exporter.splunkhec "default" {
	retry_on_failure {
		enabled = false
	}

	client {
		endpoint                = "http://splunkhec.domain.com:8088"
		timeout                 = "5s"
		max_idle_conns          = 200
		max_idle_conns_per_host = 200
		idle_conn_timeout       = "10s"
		write_buffer_size       = 8000
	}

	sending_queue {
		enabled = false
	}

	splunk {
		token            = "SPLUNK_TOKEN"
		source           = "otel"
		sourcetype       = "otel"
		index            = "devnull"
		log_data_enabled = true

		heartbeat {
			interval = "5s"
		}

		batcher {
			flush_timeout = "200ms"
		}

		telemetry {
			enabled                = true
			override_metrics_names = {
				otelcol_exporter_splunkhec_heartbeats_failed = "app_heartbeats_failed_total",
				otelcol_exporter_splunkhec_heartbeats_sent   = "app_heartbeats_success_total",
			}
			extra_attributes = {
				host   = "myhost",
				dataset_name = "SplunkCloudBeaverStack",
			}
		}
	}
}

兼容组件

otelcol.exporter.splunkhec 具有可以被以下组件使用的导出

• 消耗 OpenTelemetry otelcol.Consumer 的组件