Skip to content

Getting Started

Overview

Coralogix offers Standalone Observability using OpenTelemetry for comprehensive host and application observability. With our OpenTelemetry Collector installer, you can collect logs, metrics, and traces from your hosts.

Use our guided interface to automatically generate a tailored OpenTelemetry configuration and installation script based on your environment and use case. Enable logs, metrics, traces, and advanced features with just a few clicks—no configuration fatigue, no manual setup.

Integration overview

  • Application monitoring - Collect traces, generate metrics from spans, apply sampling strategies, and enable profiling—all to monitor application performance efficiently.
  • Advanced log handling - Collect system logs from journald (Linux) or file-based logs, support multiline log parsing, and reduce payload size by removing unused metadata.
  • Infrastructure & metrics - Capture system metrics at the host level—CPU, memory, disk, network—alongside StatsD ingestion and internal collector telemetry. Enable automatic service discovery for databases and common services.
  • Platform & fleet controls - Manage collectors centrally through OpAMP-based fleet management (supervisor mode) or use local configuration management.

Coralogix features enabled

Unlock deep observability and cost-efficient monitoring with a single toggle—no manual configuration needed.

  • APM - End-to-end tracing using OpenTelemetry with optional eBPF auto-instrumentation for zero-code coverage. Includes head sampling strategies to control volume and focus on high-value traces. Automatically generates span metrics to transform and aggregate trace data into metrics, ensuring 100% APM metric coverage regardless of the sampling strategy.
  • Continuous Profiling - Analyzes software behavior over time by collecting data on its execution. This includes measuring function execution times, CPU usage, and other system resource consumption along with relevant metadata. Continuous Profiling enables teams to correlate resource inefficiencies or performance issues, offering granular insights into application behavior.
  • Logs and metrics - Collection of enriched application logs, multiline stack traces, system logs from journald (Linux) or file-based logs, and system metrics from hosts—all tagged with metadata for context-aware filtering and analysis. Once ingested, logs and metrics become a powerful input across the Coralogix platform—powering alerts, dashboards, and many other features.
  • Infrastructure Explorer - Explore a live, searchable inventory of your infrastructure resources with full real-time context. See hosts, services, and processes alongside tags, ownership, versions, and relationships—no manual mapping required. Quickly audit costs, track accountability, and navigate complex systems without relying on spreadsheets or static dashboards.
  • Fleet Management - Centralize control of your OpenTelemetry agents by monitoring, configuring, and maintaining them at scale through supervisor mode.

Prerequisites

Warning

If you've already installed the collector manually, 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.

  1. System requirements:
  2. curl and tar commands available
  3. Root/sudo access for installation
  4. Outbound HTTPS access to Coralogix endpoints (ports 443, 4317, 4318)
  5. Coralogix credentials:
  6. A Coralogix Send-Your-Data API key

Supervisor mode prerequisites

To enable supervisor mode (Fleet Management), you'll also need: - Your Coralogix domain

Installation

Follow the steps below to deploy the Coralogix OpenTelemetry Collector on your standalone host.

Set up the integration in Coralogix

  1. Access Data Flow > Integrations.
  2. From the Integrations section, select Host OpenTelemetry integration.

  3. On the Host OpenTelemetry integration integration page, click + Add New to create a new integration. For existing integrations, click the arrow icon on the right to upgrade to the new version.

  4. Provide a name to identify this integration.

  5. Enter a Send-Your-Data API key or click Create a New Key to generate a new dedicated API key.
  6. Enter the Application name (default: "otel"). This identifies the application for which the integration is configured.
  7. Enter the Subsystem Name (default: "integration"). This helps organize and filter your telemetry data.
  8. Select the Operating System where the collector will be deployed: Linux (Mac and Windows are coming soon).
  9. Select the Deployment Environment: On premise, AWS, GCP, or Azure.
  10. Click Next.

Select observability features

  1. Toggle the observability features you want to enable through this integration. Toggling a feature will include the relevant configuration in your generated OpenTelemetry config file.

  2. Click Save.

Review and deploy

This step in the integration UI provides all required commands and configuration. The UI offers three deployment methods:

Option 1: Script deployment with config file download

  1. Download the generated configuration file (otel-config.yaml) from the UI.

  2. Run the installation command referencing the downloaded config file:

    CORALOGIX_PRIVATE_KEY="your-api-key-here" \
  bash -c "$(curl -sSL https://github.com/coralogix/telemetry-shippers/releases/latest/download/coralogix-otel-collector.sh)" \
  -- --config <otel-config.yaml file path>

Option 2: Script deployment with inline command

  1. Copy the generated deployment command from the UI. This command includes the configuration inline and will create the config file and deploy the collector in a single step.
  2. Execute the copied command on your host.

Option 3: Manual deployment

Follow the on-screen instructions in the UI to complete the manual deployment process.

When finished, return to the UI and 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.
  • Supervisor mode is only available on Linux (not supported on macOS).

Next steps

For platform-specific installation and advanced configuration instructions, see:

Additional resources

DocumentationGitHub Repository
OpenTelemetry DocumentationOpenTelemetry Collector

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 [email protected].

Need help? Contact Support.
What's new? Find out here.
LLM? Read llms.txt.
Previous Getting Started
Next Linux