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-1931]: add Highlight destination support and documentation #2088

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,7 @@ For more details, see our [quickstart guide](https://docs.odigos.io/intro).
| Google Cloud Storage | ✅ | | ✅ |
| Grafana Cloud | ✅ | ✅ | ✅ |
| Groundcover inCloud | ✅ | ✅ | ✅ |
| Highlight | ✅ | | ✅ |
| Honeycomb | ✅ | ✅ | ✅ |
| HyperDX | ✅ | ✅ | ✅ |
| KloudMate | ✅ | ✅ | ✅ |
Expand Down
39 changes: 39 additions & 0 deletions common/config/highlight.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
package config

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

type Highlight struct{}

func (j *Highlight) DestType() common.DestinationType {
return common.HighlightDestinationType
}

func (j *Highlight) ModifyConfig(dest ExporterConfigurer, currentConfig *Config) error {
uniqueUri := "highlight-" + dest.GetID()

exporterName := "otlp/" + uniqueUri
currentConfig.Exporters[exporterName] = GenericMap{
"endpoint": "https://otel.highlight.io:4318",
"headers": GenericMap{
"x-highlight-project": "${HIGHLIGHT_PROJECT_ID}",
},
}

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

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

return nil
}
1 change: 1 addition & 0 deletions common/config/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ var availableConfigers = []Configer{
&GrafanaCloudPrometheus{},
&GrafanaCloudTempo{},
&Groundcover{},
&Highlight{},
&Honeycomb{},
&HyperDX{},
&Jaeger{},
Expand Down
1 change: 1 addition & 0 deletions common/dests.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ const (
GrafanaCloudPrometheusDestinationType DestinationType = "grafanacloudprometheus"
GrafanaCloudTempoDestinationType DestinationType = "grafanacloudtempo"
GroundcoverDestinationType DestinationType = "groundcover"
HighlightDestinationType DestinationType = "highlight"
HoneycombDestinationType DestinationType = "honeycomb"
HyperDxDestinationType DestinationType = "hyperdx"
JaegerDestinationType DestinationType = "jaeger"
Expand Down
23 changes: 23 additions & 0 deletions destinations/data/highlight.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
apiVersion: internal.odigos.io/v1beta1
kind: Destination
metadata:
type: highlight
displayName: Highlight
category: managed
spec:
image: highlight.svg
signals:
traces:
supported: true
metrics:
supported: false
logs:
supported: true
fields:
- name: HIGHLIGHT_PROJECT_ID
displayName: Highlight Project ID
componentType: input
secret: true
componentProps:
type: password
required: true
7 changes: 7 additions & 0 deletions destinations/logos/highlight.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 @@ -24,6 +24,7 @@ Odigos has destinations for many observability backends.
| Google Cloud Storage | Managed | ✅ | | ✅ |
| Grafana Cloud | Managed | ✅ | ✅ | ✅ |
| Groundcover inCloud | Managed | ✅ | ✅ | ✅ |
| Highlight | Managed | ✅ | | ✅ |
| Honeycomb | Managed | ✅ | ✅ | ✅ |
| HyperDX | Managed | ✅ | ✅ | ✅ |
| Jaeger | Self-Hosted | ✅ | | |
Expand Down
59 changes: 59 additions & 0 deletions docs/backends/highlight.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
title: 'Highlight'
---

## Configuring Backend

- **HIGHLIGHT_PROJECT_ID** - Project ID, generated via Highligh UI.

**Note:**
We handle the endpoint internally, so you don't need to provide it.
- The endpoint is `https://otel.highlight.io:4318`.

## 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: highlight-example
namespace: odigos-system
spec:
data: {}
destinationName: highlight
secretRef:
name: highlight-secret
signals:
- TRACES
- LOGS
type: highlight

---
apiVersion: v1
data:
HIGHLIGHT_PROJECT_ID: <base64 Highlight Project ID>
kind: Secret
metadata:
name: highlight-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 @@ -198,6 +198,7 @@
"backends/grafanacloudprometheus",
"backends/grafanacloudtempo",
"backends/groundcover",
"backends/highlight",
"backends/honeycomb",
"backends/hyperdx",
"backends/jaeger",
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 @@ -36,6 +36,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="Groundcover inCloud" href="/backends/groundcover" />
<Card title="Highlight" href="/backends/highlight" />
<Card title="Honeycomb" href="/backends/honeycomb" />
<Card title="HyperDX" href="/backends/hyperdx" />
<Card title="Jaeger" href="/backends/jaeger" />
Expand Down
Loading