Lightstep

CatalogScorecards

Overview

ServiceNow Cloud Observability, formerly known as Lightstep, helps you detect changes in your logs, metrics, and traces. Integrate Lightstep with Cortex to drive insights into SLOs and latency and error rate metrics.

How to configure Lightstep with Cortex

Prerequisite

Before getting started, create a Lightstep API key.

Configure the integration in Cortex

1. In Cortex, navigate to the Lightstep settings page:
   1. In Cortex, click your avatar in the lower left corner, then click Settings.
   2. Under "Integrations", click Lightstep.
2. Configure the Lightstep integration form:
   • Org ID: Enter your Lightstep organization ID.
     • You can find this in your Lightstep project settings.
   • Project ID: Enter the Lightstep project ID.
     • You can find this in your Lightstep project URL, e.g., https://app.lightstep.com/PROJECT_ID/project
   • API key: Enter the API key you generated in Lightstep.
3. Click Save.

caution

If you do not see the settings page you're looking for, you likely don't have the proper permissions and need to contact your admin.

Linking SLOs in Cortex

You can create and manage SLOs by listing relevant latency SLIs through Streams. Cortex will pull data from Lightstep, and track against your specified SLO. For example:

x-cortex-slos:
  lightstep:
    - streamId: sc4jmdXT
      targets:
        latency:
          - percentile: 0.5
            target: 2
            slo: 0.9995

Field	Description
streamId	ID of your Lightstep stream, which can be found in Lightstep, through the URL. https://app.lightstep.com/{org}/stream/my-stream/{streamId}
percentile	Percentile latency for your given streamId, out of 1
target	Latency targets in ms. Latency is currently the only target supported
slo	SLO percentile, out of 1

Expected results

Entity pages

When an SLO is defined in an entity's descriptor, you'll see detailed data about SLOs in the Operations tab. Click into the Pass or Fail blocks (if they have a nonzero value) to open a modal with more information.

On the left side of an entity, click Integrations > Lightstep to view the SLO query, target(s), current value for each SLO, and a graph of SLO performance over time.

Scorecards and CQL

With the Lightstep integration, you can create Scorecard rules and write CQL queries based on Lightstep SLOs.

See more examples in the CQL Explorer in Cortex.

SLOs

SLOs associated with the entity via ID or tags. You can use this data to check whether an entity has SLOs associated with it, and if those SLOs are passing.

Definition: slos: List<SLO>

Example

In a Scorecard, you can use this expression to make sure an entity is passing its SLOs:

slos().all((slo) => slo.passing) == true

Use this expression to make sure latency Service Level Indicator (SLI) value is above 99.99%:

slos().filter((slo) => slo.name.matchesIn("latency") and slo.sliValue >= 0.9999).length > 0

Still need help?

The following are all the ways to get assistance from our customer engineering team. Please use the option that is best for your users:

• Email: help@cortex.io, or open a support ticket in the in app Resource Center
• Chat: Available in the Resource Center
• Slack: Users with a connected Slack channel will have a workflow added to their account. From here, you can either @CortexTechnicalSupport or add a :ticket: reaction to a question in Slack, and the team will respond directly.

Don’t have a Slack channel? Talk with your customer success manager.