Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[GEN-1932]: add HyperDX destination support and documentation #2084

Merged
merged 9 commits into from
Dec 29, 2024
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,7 @@ For more details, see our [quickstart guide](https://docs.odigos.io/intro).
| Google Cloud Storage | ✅ | | ✅ |
| Grafana Cloud | ✅ | ✅ | ✅ |
| Honeycomb | ✅ | ✅ | ✅ |
| HyperDX | ✅ | ✅ | ✅ |
| Last9 | ✅ | ✅ | |
| Lightstep | ✅ | | |
| Logz.io | ✅ | ✅ | ✅ |
Expand Down
48 changes: 48 additions & 0 deletions common/config/hyperdx.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
package config

import (
"github.com/odigos-io/odigos/common"
)

type HyperDX struct{}

func (j *HyperDX) DestType() common.DestinationType {
return common.HyperDxDestinationType
}

func (j *HyperDX) ModifyConfig(dest ExporterConfigurer, cfg *Config) error {
uniqueUri := "hdx-" + dest.GetID()

exporterName := "otlp/" + uniqueUri
exporterConfig := GenericMap{
"endpoint": "in-otel.hyperdx.io:4317",
"headers": GenericMap{
"authorization": "${HYPERDX_API_KEY}",
},
}

cfg.Exporters[exporterName] = exporterConfig

if isTracingEnabled(dest) {
pipeName := "traces/" + uniqueUri
cfg.Service.Pipelines[pipeName] = Pipeline{
Exporters: []string{exporterName},
}
}

if isMetricsEnabled(dest) {
pipeName := "metrics/" + uniqueUri
cfg.Service.Pipelines[pipeName] = Pipeline{
Exporters: []string{exporterName},
}
}

if isLoggingEnabled(dest) {
pipeName := "logs/" + uniqueUri
cfg.Service.Pipelines[pipeName] = Pipeline{
Exporters: []string{exporterName},
}
}

return nil
}
2 changes: 1 addition & 1 deletion common/config/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ var availableConfigers = []Configer{
&AppDynamics{}, &Axiom{}, &AWSS3{}, &AzureBlobStorage{}, &Causely{}, &Chronosphere{}, &Clickhouse{}, &Coralogix{},
&Datadog{}, &Debug{}, &Dynatrace{}, &ElasticAPM{}, &Elasticsearch{}, &GenericOTLP{}, &GoogleCloud{},
&GoogleCloudStorage{}, &GrafanaCloudLoki{}, &GrafanaCloudPrometheus{}, &GrafanaCloudTempo{},
&Honeycomb{}, &Jaeger{}, &Last9{}, &Lightstep{}, &Logzio{}, &Loki{}, &Lumigo{}, &Middleware{}, &Mock{}, &NewRelic{},
&Honeycomb{}, &HyperDX{}, &Jaeger{}, &Last9{}, &Lightstep{}, &Logzio{}, &Loki{}, &Lumigo{}, &Middleware{}, &Mock{}, &NewRelic{},
&Nop{}, &OpsVerse{}, &OTLPHttp{}, &Prometheus{}, &Qryn{}, &QrynOSS{}, &Quickwit{}, &Sentry{},
&Signoz{}, &Splunk{}, &SumoLogic{}, &Tempo{}, &Uptrace{},
}
Expand Down
1 change: 1 addition & 0 deletions common/dests.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ const (
GrafanaCloudPrometheusDestinationType DestinationType = "grafanacloudprometheus"
GrafanaCloudTempoDestinationType DestinationType = "grafanacloudtempo"
HoneycombDestinationType DestinationType = "honeycomb"
HyperDxDestinationType DestinationType = "hyperdx"
JaegerDestinationType DestinationType = "jaeger"
Last9DestinationType DestinationType = "last9"
LightstepDestinationType DestinationType = "lightstep"
Expand Down
23 changes: 23 additions & 0 deletions destinations/data/hyperdx.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
apiVersion: internal.odigos.io/v1beta1
kind: Destination
metadata:
type: hyperdx
displayName: HyperDX
category: managed
spec:
image: hyperdx.svg
signals:
traces:
supported: true
metrics:
supported: true
logs:
supported: true
fields:
- name: HYPERDX_API_KEY
displayName: HyperDX API Key
componentType: input
secret: true
componentProps:
type: password
required: true
7 changes: 7 additions & 0 deletions destinations/logos/hyperdx.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/backends-overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Odigos has destinations for many observability backends.
| Google Cloud Storage | Managed | ✅ | | ✅ |
| Grafana Cloud | Managed | ✅ | ✅ | ✅ |
| Honeycomb | Managed | ✅ | ✅ | ✅ |
| HyperDX | Managed | ✅ | ✅ | ✅ |
| Jaeger | Self-Hosted | ✅ | | |
| Last9 | Managed | ✅ | ✅ | |
| Lightstep | Managed | ✅ | | |
Expand Down
60 changes: 60 additions & 0 deletions docs/backends/hyperdx.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
title: 'HyperDX'
---

## Configuring Backend

- **HYPERDX_API_KEY** - HyperDX API Key.

**Note:**
We handle the endpoint internally, so you don't need to provide it.
- The endpoint is `in-otel.hyperdx.io:4317`.

## Adding a Destination to Odigos

Odigos makes it simple to add and configure destinations, allowing you to select the specific signals [traces/logs/metrics] that you want to send to each destination. There are two primary methods for configuring destinations in Odigos:

1. **Using the UI**

Use the [Odigos CLI](https://docs.odigos.io/cli/odigos_ui) to access the UI:

```bash
odigos ui
```

2. **Using kubernetes manifests**

Save the YAML below to a file (e.g., `destination.yaml`) and apply it using `kubectl`:

```bash
kubectl apply -f destination.yaml
```


```yaml
apiVersion: odigos.io/v1alpha1
kind: Destination
metadata:
name: hyperdx-example
namespace: odigos-system
spec:
data: {}
destinationName: hyperdx
secretRef:
name: hyperdx-secret
signals:
- TRACES
- METRICS
- LOGS
type: hyperdx

---
apiVersion: v1
data:
HYPERDX_API_KEY: <base64 HyperDX API Key>
kind: Secret
metadata:
name: hyperdx-secret
namespace: odigos-system
type: Opaque
```
1 change: 1 addition & 0 deletions docs/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,7 @@
"backends/grafanacloudprometheus",
"backends/grafanacloudtempo",
"backends/honeycomb",
"backends/hyperdx",
"backends/jaeger",
"backends/last9",
"backends/lightstep",
Expand Down
1 change: 1 addition & 0 deletions docs/quickstart/next-steps.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ Select the relevant backend for your use case below to connect it to Odigos.
<Card title="Grafana Cloud Prometheus" href="/backends/grafanacloudprometheus" />
<Card title="Grafana Cloud Tempo" href="/backends/grafanacloudtempo" />
<Card title="Honeycomb" href="/backends/honeycomb" />
<Card title="HyperDX" href="/backends/hyperdx" />
<Card title="Jaeger" href="/backends/jaeger" />
<Card title="Last9" href="/backends/last9" />
<Card title="Lightstep" href="/backends/lightstep" />
Expand Down
Loading