Skip to content

Commit

Permalink
docs fmt
Browse files Browse the repository at this point in the history
  • Loading branch information
NimrodAvni78 committed Dec 25, 2024
1 parent 5d885c6 commit 63fc16f
Showing 1 changed file with 22 additions and 5 deletions.
27 changes: 22 additions & 5 deletions otel-integration/k8s-helm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -439,16 +439,15 @@ helm upgrade --install otel-coralogix-integration coralogix-charts-virtual/otel-
### Deploying Coralogix EBPF Agent

```bash
helm upgrade --install otel-coralogix-central-collector coralogix-charts-virtual/otel-integration \
helm upgrade --install otel-coralogix 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
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`.


#### Filtering Specific Services For Coralogix EBPF Agent

By default, the coralogix-ebpf-agent will collect traffic from all services in the cluster.
Expand Down Expand Up @@ -488,7 +487,7 @@ 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 upgrade --install otel-coralogix-central-collector coralogix-charts-virtual/otel-integration \
helm upgrade --install otel-coralogix 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>
```

Expand Down Expand Up @@ -747,6 +746,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

0 comments on commit 63fc16f

Please sign in to comment.