This section describes how to install and configure the Gateway Managed OTel Collector.

Prerequisites

Before installing the Gateway Managed OTel Collector:

  • Enable Log Management at the client level. This permission is required to ingest and forward logs to the cloud.
  • Ensure your environment uses OpsRamp NextGen Gateway version 21.1.0 or later. Using the latest version is recommended for complete feature coverage and improvements.

Resource Allocation
To ensure stable performance, the integration defines resource requests and limits during installation. These values guarantee a baseline of resources while allowing flexibility under higher load conditions.

Guaranteed Usage:

  • Memory: 50 MB
  • CPU: 250 millicores (0.25 CPU)

Maximum Allowed Usage:

  • Memory: 100 MB
  • CPU: 500 millicores (0.5 CPU)

Enable Log Management

To enable Log Management, select Partner and Client and then click Setup → Account → Settings → ADD-ONS. In ADD-ONS select Log Management checkbox and click Save to reflect the changes.


Along with enabling Log Management, you must also enable the Syslog Collection option in the SysLog Monitor Configuration so that Syslog messages received at the gateway can be forwarded to the OpsRamp cloud.

If disabled, logs cannot be forwarded, even if the OTel Collector is installed. If both options are disabled, logs cannot be forwarded, even if the OTel Collector is installed.

Install the Gateway Managed OTel Collector

To install the integration:

  1. Navigate to Partner → All Clients and select the appropriate Client
  2. Go to Setup → Account
  3. Open Integrations to view installed integrations
  4. Click + ADD to install a new integration
  5. Locate and select Gateway Managed OpenTelemetry (OTel) Collector
  6. Provide the Basic Information:
    • Name – Enter integration name
    • Description (Optional) – Describe the purpose of the integration


Add an OTel Configuration

In the configuration window:

  1. Click + ADD
  2. Provide the following configuration details:

Configuration Fields

Field NameTypeDescription
NameStringName of the configuration
Run Gateway-managed OTel on the same node as OpsRamp GatewayCheckboxRuns OTel Collector on the same Gateway node or any eligible Kubernetes node.
When this option is enabled, the OTel Collector runs on the same node as the OpsRamp Gateway. When it is disabled, the Collector can run on any eligible node in the Kubernetes cluster where a gateway is available.
Note: Select the checkbox to ensure that the OTel collector deploys only to the intended single node when multiple nodes are available.
OTel Configuration YAMLYAMLDefines how logs are collected, filtered, and exported

Configure the OTel collector using YAML

The OTel Collector uses a YAML configuration file to control how syslog messages are collected, filtered, processed, and forwarded to OpsRamp.

The following is the YAML configuration

Logs:
  enable: true
  filter:
   log_record:
    - '<rule 1 or condition 1>'
    - '<rule 2 or condition 2>'
    - <rules or more conditions>

All Rules under log_record are evaluated using OR logic; if any condition evaluates to true, the corresponding log entry is dropped.

You can define detailed filtering rules to determine which syslog messages are included or excluded before forwarding. For more information see Filtering Use Cases.

You can define filters for syslog attributes such as:

  • Level
  • IP address
  • Priority
  • Facility
  • Message content

Select Collector Profile

After validating your YAML configuration, the installation wizard prompts you to select a Collector Profile. Only NextGen Gateway Collector Profiles are displayed.

To complete installation:

  1. Select a connected Collector Profile.
  2. Confirm the selection.
  3. Click Finish.

After enabling this integration, allow time for the OTel Collector to finish installing on the gateway. Once installation is complete, only NextGen gateways with the OTel Collector installed will appear in the syslog monitor configuration when you enable the Syslog Collection option.