Skip to main content

Coralogix

CatalogDiscoveryScorecards

Summary​

Coralogix is an observability platform. You can use Coralogix to drive insights into values such as:

  • Alerts

Setup​

In order to connect Cortex to your Coralogix instance, you’ll need to add a Coralogix API key under Settings → Coralogix.

The Coralogix integration has multi-account support. You can add a configuration for each additional by repeating the process above.

Each configuration requires an alias, which Cortex uses to correlate the designated with registrations for various entities. Registrations can also use a default configuration without a listed alias. You can edit aliases and default configurations from the Coralogix page in your Cortex settings. Select the edit icon next to a given configuration and toggle Set as default on. If you only have one configuration, it will automatically be set as the default.

caution

If you do not see the settings page you're looking for, you may not have permission to access that page. Please contact your admin for assistance.

Registration​

Discovery​

By default, Cortex will use the entity name or entity tag (e.g. my-service) as the "best guess" for the Coralogix alert application name. For example, if your entity name is "My Service" and your entity tag is “my-service”, then the corresponding application name in Coralogix should be “My Service” or "my-service".

If your Coralogix application names don’t cleanly match the Cortex entity identifier, you can override this in the Cortex entity descriptor.

Entity descriptor​

If you need to override automatic discovery, you can define the following block in your Cortex entity descriptor.

Coralogix alerts can be listed in the Catalog under the Coralogix section. We support application names in the YAML for pulling Coralogix alerts.

info:
  x-cortex-coralogix:
    applications:
    - applicationName: my-app # application name tied to alert
      alias: my-alias # alias is optional and only relevant if you have opted into multi account support