changelog

coralogix · Dec 23, 2024 · 2ae0e2e · 2ae0e2e
1 parent 0ded931
commit 2ae0e2e
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 8 deletions.
diff --git a/otel-integration/CHANGELOG.md b/otel-integration/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## OpenTelemtry-Integration
 
+### v0.0.128 / 2024-12-23
+
+- [Feat] default to span metrics enable for ebpf agent deployment
+
 ### v0.0.127 / 2024-12-20
 
 - [Fix] Make the receiver Collector report as agent type `receiver`

diff --git a/otel-integration/k8s-helm/Chart.yaml b/otel-integration/k8s-helm/Chart.yaml
@@ -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

diff --git a/otel-integration/k8s-helm/README.md b/otel-integration/k8s-helm/README.md
@@ -134,8 +134,6 @@ Componentes:
 - k8s-watcher - The agent that watches for changes in k8s resources and publishes them to redis pubsub for coralogix-ebpf-agent to consume them, running as a deployment with 1 replica.
 - redis - Redis Pubsub is used for communication between k8s-watcher and coralogix-ebpf-agent, running as a sts with 1 replica.
 
-to enable the coralogix-ebpf-agent deployment, set `coralogix-ebpf-agent.enabled` to `true` in the `values.yaml` file.
-
 # Prerequisites
 
 Make sure you have at least these version of the following installed:
@@ -415,9 +413,20 @@ 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>
 ```
 
-### Enabling Coralogix EBPF Agent
+### Deploying Coralogix EBPF Agent
+
+To deploy the Coralogix EBPF Agent, alongside the OpenTelemetry agent adn Collector, you can use the following command:
+
+```bash
+helm upgrade --install otel-coralogix-central-collector coralogix-charts-virtual/otel-integration \
+  --render-subchart-notes -f values-ebpf-agent.yaml
+```
+
+By default, coralogix ebpf agent will be deployed with the [span metrics preset](#About-span-metrics) enabled.
+since due to the usual high volume of spans collected by the ebpf agent, it is recommended to use 
+[Coralogix APM with span metrics](https://coralogix.com/docs/user-guides/apm/getting-started/span-metrics/)
+to disable this, you can edit to the `values-ebpf-agent.yaml` file and set `presets.spanMetrics.enabled` to `false`.
 
-To enable the coralogix EBPF agent, set `coralogix-ebpf-agent.enabled` to `true` in the `values.yaml` file.
 
 #### Filtering Specific Services For Coralogix EBPF Agent
 
@@ -458,8 +467,6 @@ If you already have an existing OpenTelemetry Collector deployment and you want
 you can only deploy the ebpf agent and supply your existing OpenTelemetry Collector endpoint with this command:
 
 ```bash
-helm repo add coralogix-charts-virtual https://cgx.jfrog.io/artifactory/coralogix-charts-virtual
-
 helm upgrade --install otel-coralogix-central-collector coralogix-charts-virtual/otel-integration \
   --render-subchart-notes -f values-ebpf-agent-existing-collector.yaml --set coralogix-ebpf-agent.ebpf_agent.otel.exporter.endpoint=<your-existing-collector-endpoint>
 ```

diff --git a/otel-integration/k8s-helm/values-ebpf-agent.yaml b/otel-integration/k8s-helm/values-ebpf-agent.yaml
@@ -0,0 +1,8 @@
+presets:
+  spanMetrics:
+    enabled: true
+    errorTracking:
+      enabled: false
+
+coralogix-ebpf-agent:
+  enabled: true
diff --git a/otel-integration/k8s-helm/values.yaml b/otel-integration/k8s-helm/values.yaml
@@ -5,7 +5,7 @@ global:
   defaultSubsystemName: "integration"
   logLevel: "warn"
   collectionInterval: "30s"
-  version: "0.0.127"
+  version: "0.0.128"
 
   extensions:
     kubernetesDashboard: