Complimentary Gartner® Report! 'A CTO's Guide to Open-Source Software: Answering the Top 10 FAQs.'Read more

Honeycomb Refinery

Description

Sends logs and traces to Honeycomb Refinery.

Prerequisites

This destination requires network access to a Honeycomb Refinery deployment.

If refinery is configured to forward telemetry to Honeycomb.io, an API key is required. The API key should have "Send Events" and "Create Dataset" permissions.

See the Honeycomb Refinery and Honeycomb quick start guide for more information.

Supported Types

LogsMetricsTracesBindplane Agent
v1.60.0+

Configuration

FieldDescription
Choose Telemetry TypeThe kind of telemetry that should be sent to Honeycomb.
HostnameHostname or IP address where the exporter will send OTLP data.
PortTCP port to which the exporter is going to send OTLP data.
API KeyThe API key to use for sending telemetry to Honeycomb. Make sure the key has the "Send Events" permission. If the provided dataset(s) do not exist, use the "Create Dataset" permission as well. See this Honeycomb documentation for more.
CompressionCompression algorithm to use when sending data to Honeycomb. Available options are none or gzip.
Enable TLSWhether or not to use TLS.
Skip TLS Certificate VerificationEnable to skip TLS certificate verification.
TLS Certificate Authority FileCertificate authority used to validate TLS certificates.
Server Name OverrideOptional virtual hostname. Indicates the name of the server requested by the client. This option is generally not required. Read more here.
Mutual TLSWhether or not to use mutual TLS authentication.
Mutual TLS Client Certificate FileA TLS certificate used for client authentication.
Mutual TLS Client Private Key FileA TLS private key used for client authentication.

This destination supports the following retry and queuing settings:

Sending QueuePersistent QueueRetry on Failure

Honeycomb Datasets

Your Refinery server can be configured to route telemetry to specific Honeycomb datasets, however, Refinery will respect the service.name resource field when determining which dataset the telemetry should belong to.

You can route telemetry to datasets dynamically by using the Add Fields processor to set service.name resource field.

Example Configuration

Web Interface

observIQ docs - Honeycomb Refinery Destination - image 1

Standalone Destination

yaml
1apiVersion: bindplane.observiq.com/v1
2kind: Destination
3metadata:
4  name: honeycomb-refinery
5spec:
6  type: honeycomb_refinery_otlp
7  parameters:
8    - name: telemetry_types
9      value: ['Logs', 'Traces']
10    - name: hostname
11      value: refinery.default.svc.cluster.local
12    - grpc_port:
13      value: 4317
14    - name: api_key
15      value: your_api_key
16    - name: compression
17      value: gzip