Skip to content

Kubernetes Complete Observability: Basic Configuration

Overview

Coralogix offers Kubernetes Observability using OpenTelemetry for comprehensive Kubernetes and application observability. Using our OpenTelemetry Chart, the integration enables you to simplify the collection of logs, metrics, and traces from the running application in your pods to the cluster-level components of your Kubernetes cluster.

Use our powerful, guided interface to generate a tailored values.yaml file based on your environment and use case without the need for manual editing. Easily enable logs, metrics, traces and advanced features like Profiling and eBPF with just a few clicks.

Note

This integration is designed and tested for clean installs. Applying it to existing deployments may require additional checks and adjustments.

Warning

If you’ve already installed the integration using the default values.yaml, be aware that upgrading may overwrite existing configurations, and behavior in your environment is unpredictable. We strongly recommend testing updates in a staging environment first to verify compatibility, stability, and ensure you can take full advantage of new features and best practices.

Prerequisites

  1. Before setting up the integration, ensure that kubectl is installed.
  2. Make sure you run the installation with Helm v3.9+. To check the version run the following command:
    helm version
    

Integration overview

  • Application monitoring - Collect traces, generate metrics from spans, apply sampling strategies, and enable profiling—all to monitor application performance efficiently.
  • Advanced log and event handling - Ingest structured Kubernetes events, support multiline logs, and reduce payload size by removing unused metadata.
  • Infrastructure & metrics - Capture system metrics at all levels—hosts, nodes, pods, clusters—alongside StatsD ingestion and internal collector telemetry. Scale scraping with target allocation.
  • Platform & fleet controls - Add Kubernetes metadata for infrastructure visibility and manage collectors centrally through OpAMP-based fleet management.

Installation

Follow the steps below to deploy the Coralogix Kubernetes Observability integration in your cluster.

1. Set up the integration in Coralogix

  1. In your Coralogix toolbar, navigate to Data Flow > Integrations.
  2. From the Integrations section, select Kubernetes Complete Observability.
  3. On the Kubernetes Complete Observability integration page, click + Setup Collector to create a new integration. For existing integrations, click the arrow icon on the right to upgrade to the new version.

    k8s integration upgrade

  4. Provide a name to identify this integration (especially useful if you have multiple clusters).

  5. Enter a Send-Your-Data API key or click Create a New Key to generate a new dedicated API key.
  6. Enter your Kubernetes cluster name in the Cluster Name field.
  7. Enter your Kubernetes namespace in the Namespace field. If left empty, the namespace from your current kubectl context will be used.
  8. Select the operating system and environment that your Kubernetes workloads are deployed on.
  9. Click Next.

2. Select observability features

  1. Toggle the observability features you want to enable through this integration. Toggling a feature will include the relevant fields and values in your resulting values.yaml configuration file.

  2. Click Save.

3. Review and deploy

  1. To create the Coralogix Helm repository, run the following command:

    helm repo add coralogix https://cgx.jfrog.io/artifactory/coralogix-charts-virtual
    helm repo update
    
  2. Ensure that your Kubernetes cluster contains a secret named coralogix-keys, with a key called PRIVATE_KEY present in your cluster.
    If this secret is missing or doesn't include the required key, create it using the following kubectl command:

    kubectl create secret generic coralogix-keys --from-literal=PRIVATE_KEY="<private_key>"
    

    You can also find a pre-filled version of this command—including your private key—in the setup instructions shown in the UI.

  3. Copy and save the content of the auto-generated values.yaml file below. Alternatively, download it using the Download button.

  4. After creating the secret in your Kubernetes cluster, execute the following command.
    Make sure to replace <values.yaml file path> with the actual path to your values.yaml file.

    helm upgrade --install otel-coralogix-integration coralogix/otel-integration --version=0.0.202 --render-subchart-notes -f <values.yaml file path>
    

    Alternatively, click on Deployment code to view and copy the upgrade command with the full values.yaml content embedded in it.

  5. Click Complete setup.

Limitations

  • Coralogix places a hard limit of 10MB of data to our OpenTelemetry Endpoints, with a recommendation of 2MB.
  • Metric names must be a maximum of 255 characters.
  • Attribute keys for metric data must be a maximum of 255 characters.

Next Steps

Advanced configuration instructions can be found here.

Validation instructions can be found here.

Additional Resources

DocumentationGitHub Repository
Kubernetes Dashboard

Support

Need help?

Our world-class customer success team is available 24/7 to walk you through your setup and answer any questions that may come up.

Feel free to reach out to us via our in-app chat or by sending us an email at support@coralogix.com.