Bindplane Gateway
Description
The Bindplane Gateway source is an OTLP source meant to be used for gateway nodes. When using this source in conjunction with a Bindplane Gateway destination from another configuration, telemetry traveling through this source will not be double counted in the Summary view.
Supported Platforms
Linux
✓
✓
✓
Windows
✓
✓
✓
macOS
✓
✓
✓
Kubernetes Node (DaemonSet)
✓
✓
✓
Kubernetes Gateway
✓
✓
✓
OpenShift 4 Node (DaemonSet)
✓
✓
✓
OpenShift Gateway
✓
✓
✓
Configuration Table
telemetry_types
telemetrySelector
["Logs", "Metrics", "Traces"]
Choose Telemetry Type.
listen_address
string
"0.0.0.0"
The IP address to listen on.
grpc_port
int
4317
TCP port to receive OTLP telemetry using the gRPC protocol. The port used must not be the same as the HTTP port. Set to 0 to disable.
http_port
int
4318
TCP port to receive OTLP telemetry using the HTTP protocol. The port used must not be the same as the gRPC port. Set to 0 to disable.
enable_tls
bool
false
Whether or not to use TLS.
insecure_skip_verify
bool
false
Enable to skip TLS certificate verification.
ca_file
string
Certificate authority used to validate the database server's TLS certificate.
cert_file
string
A TLS certificate used for client authentication if mutual TLS is enabled.
key_file
string
A TLS private key used for client authentication if mutual TLS is enabled.
Example Configuration
The Bindplane Gateway source type does not have any required fields. By default, the Bindplane Gateway source will listen on ports 4317/gRPC and 4318/HTTP on all IP addresses without TLS.
Kubernetes
The Bindplane Gateway source type supports Kubernetes, OpenShift Node (DaemonSet), and Gateway collectors. Applications within the cluster can forward metrics, logs, and traces to the collectors using the clusterIP services.
Prerequisites
Bindplane v1.52.0 or newer
Configuration
The Bindplane Gateway source type does not require additional configuration. It can be attached to any Kubernetes, OpenShift Node (DaemonSet), or Gateway configuration.
The following endpoints can forward telemetry to the managed Node (DaemonSet) collectors.
gRPC
clusterIP
bindplane-node-agent.bindplane-agent.svc.cluster.local:4317
gRPC
headless clusterIP
bindplane-node-agent-headless.bindplane-agent.svc.cluster.local:4317
HTTP
clusterIP
http://bindplane-node-agent.bindplane-agent.svc.cluster.local:4318
The following endpoints can forward telemetry to the managed Gateway collectors.
gRPC
clusterIP
bindplane-gateway-agent.bindplane-agent.svc.cluster.local:4317
gRPC
headless clusterIP
bindplane-gateway-agent-headless.bindplane-agent.svc.cluster.local:4317
HTTP
clusterIP
http://bindplane-gateway-agent.bindplane-agent.svc.cluster.local:4318
It is a matter of preference if you should forward telemetry to the DaemonSet or Gateway collectors. It is recommended to use the Gateway collector, if DaemonSet resource consumption is a concern, as the Gateway collector can scale independent of cluster size.
Last updated
Was this helpful?