Skip to content

Commit

Permalink
Merge branch 'master' of github.com:coralogix/telemetry-shippers into…
Browse files Browse the repository at this point in the history
… document-oamp-extension-eks
  • Loading branch information
douglascamata committed Dec 24, 2024
2 parents 54598a0 + bbd9b05 commit 6bfa152
Show file tree
Hide file tree
Showing 5 changed files with 131 additions and 2 deletions.
4 changes: 4 additions & 0 deletions otel-integration/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

## OpenTelemtry-Integration

### v0.0.128 / 2024-12-23

- [Feat] add k8s ipv6 only support

### v0.0.127 / 2024-12-20

- [Fix] Make the receiver Collector report as agent type `receiver`
Expand Down
2 changes: 1 addition & 1 deletion otel-integration/k8s-helm/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
apiVersion: v2
name: otel-integration
description: OpenTelemetry Integration
version: 0.0.127
version: 0.0.128
keywords:
- OpenTelemetry Collector
- OpenTelemetry Agent
Expand Down
41 changes: 41 additions & 0 deletions otel-integration/k8s-helm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -415,6 +415,29 @@ helm upgrade --install otel-coralogix-integration coralogix-charts-virtual/otel-
--render-subchart-notes -f gke-autopilot-values.yaml --set global.clusterName=<cluster_name> --set global.domain=<domain>
```

### Installing the chart on IPV6 Only clusters.

To run otel-integration inside IPV6 only cluster, you need to install using `ipv6-values.yaml` file.

First make sure to add our Helm charts repository to the local repos list with the following command:

```bash
helm repo add coralogix-charts-virtual https://cgx.jfrog.io/artifactory/coralogix-charts-virtual
```

In order to get the updated Helm charts from the added repository, please run:

```bash
helm repo update
```

Install the chart with the `ipv6-values.yaml` file. You can either provide the global values (secret key, cluster name) by adjusting the main `values.yaml` file and then passing the `values.yaml` file to the `helm upgrade` command as following:

```bash
helm upgrade --install otel-coralogix-integration coralogix-charts-virtual/otel-integration \
--render-subchart-notes -f values.yaml -f ipv6-values.yaml
```

### Enabling Coralogix EBPF Agent

To enable the coralogix EBPF agent, set `coralogix-ebpf-agent.enabled` to `true` in the `values.yaml` file.
Expand Down Expand Up @@ -719,6 +742,24 @@ helm upgrade --install otel-coralogix-integration coralogix-charts-virtual/otel-

Once the installation is complete, verify that the Kube State Metrics metrics are being scraped and ingested inside Coralogix.

### Connecting to Coralogix fleet management

The integration can be configured to connect to the Coralogix fleet management server through setting the `presets.fleetManagement.enabled` property to `true`. This connection happens through the OpAMP extension of the Collector and the endpoint used is: `https://ingress.<CORALOGIX_DOMAIN>/opamp/v1`. This feature is disabled by default.

> [!CAUTION]
> Important security consideration when enabling this feature:
> - Because this extension shares your Collector's configuration with the fleet management server, it's important to ensure that any secret contained in it is using the environment variable expansion syntax.
> - The default capabilities of the OpAMP extension **do not** include remote configuration or packages.
> - By default, the extension will pool the server every 2 minutes. Additional network requests might be made between the server and the Collector, depending on the configuration on both sides.

To enable this feature, set the `presets.fleetManagement.enabled` property to `true`. Here is an example `values.yaml`:

```yaml
presets:
fleetManagement:
enabled: true
```

# Troubleshooting

## Metrics
Expand Down
84 changes: 84 additions & 0 deletions otel-integration/k8s-helm/ipv6-values.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
opentelemetry-agent:
enabled: true

config:
extensions:
health_check:
endpoint: "[${env:MY_POD_IP}]:13133"

receivers:
kubeletstats:
endpoint: "[${env:K8S_NODE_IP}]:10250"
statsd:
endpoint: "[${env:MY_POD_IP}]:8125"
otlp:
protocols:
grpc:
endpoint: "[${env:MY_POD_IP}]:4317"
http:
endpoint: "[${env:MY_POD_IP}]:4318"
zipkin:
endpoint: "[${env:MY_POD_IP}]:9411"
jaeger:
protocols:
grpc:
endpoint: "[${env:MY_POD_IP}]:14250"
thrift_http:
endpoint: "[${env:MY_POD_IP}]:14268"
thrift_compact:
endpoint: "[${env:MY_POD_IP}]:6831"
thrift_binary:
endpoint: "[${env:MY_POD_IP}]:6832"
prometheus:
config:
scrape_configs:
- job_name: opentelemetry-collector
scrape_interval: 30s
static_configs:
- targets:
- "[${env:MY_POD_IP}]:8888"

service:
telemetry:
metrics:
address: "[${env:MY_POD_IP}]:8888"

opentelemetry-cluster-collector:
enabled: true
config:
extensions:
health_check:
endpoint: "[${env:MY_POD_IP}]:13133"
receivers:
otlp:
protocols:
grpc:
endpoint: "[${env:MY_POD_IP}]:4317"
http:
endpoint: "[${env:MY_POD_IP}]:4318"
jaeger:
protocols:
grpc:
endpoint: "[${env:MY_POD_IP}]:14250"
thrift_http:
endpoint: "[${env:MY_POD_IP}]:14268"
thrift_compact:
endpoint: "[${env:MY_POD_IP}]:6831"
thrift_binary:
endpoint: "[${env:MY_POD_IP}]:6832"
zipkin:
endpoint: "[${env:MY_POD_IP}]:9411"

prometheus:
config:
scrape_configs:
- job_name: opentelemetry-infrastructure-collector
scrape_interval: 30s
static_configs:
- targets:
- "[${env:MY_POD_IP}]:8888"
service:
telemetry:
metrics:
address: "[${env:MY_POD_IP}]:8888"

2 changes: 1 addition & 1 deletion otel-integration/k8s-helm/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ global:
defaultSubsystemName: "integration"
logLevel: "warn"
collectionInterval: "30s"
version: "0.0.127"
version: "0.0.128"

extensions:
kubernetesDashboard:
Expand Down

0 comments on commit 6bfa152

Please sign in to comment.