FireHydrant

FireHydrant is an incident management platform that emphasizes reliability and consistency across the entire incident response lifecycle.

Integrating FireHydrant with Cortex allows you to:

• View incidents on entity pages in Cortex, giving you insight into incidents to act on them quickly

• Trigger new incidents directly from Cortex

• Create Scorecards to set standards around incident management and production readiness

How to integrate FireHydrant with Cortex

Prerequisites

Before getting started:

• Create a FireHydrant API key.

Configure the integration in Cortex

1. In Cortex, navigate to the FireHydrant settings page:

   1. In Cortex, click your avatar in the lower left corner, then click Settings.

   2. Under "Integrations", click FireHydrant.

2. Click Add configuration.

3. Configure the integration:

   • API key: Enter the API key you created in FireHydrant.

4. Click Save.

After saving your configuration, you are redirected to the FireHydrant integration settings page in Cortex. In the upper right corner of the page, click Test configuration to ensure FireHydrant was configured properly.

How to connect Cortex entities to FireHyrant projects

Editing the entity descriptor

You can define FireHydrant services in an entity's YAML file.

For a given entity, define FireHydrant services by ID or slug. Each of these has the same field definitions.

Field	Description	Required
identifier	Service ID or slug	✓
identifierType	Type of identifier (ID or SLUG)	✓

x-cortex-firehydrant:
  services:
    - identifier: ASDF1234
      identifierType: ID

You can find the service ID value in FireHydrant under FireHydrant > Catalog > Services. The URL for the service will also contain the ID (e.g., https://app.firehydrant.io/catalog/services/{ID}/incidents).

If you prefer to use the service slug in the registration instead, you can find it on the right-hand side of the service page in FireHydrant.

x-cortex-firehydrant:
  services:
    - identifier: service-slug
      identifierType: SLUG

Using the FireHydrant integration

Viewing FireHydrant incidents on an entity

When active incidents are detected in FireHydrant, Cortex will display incident information on an entity's details page.

Click On-call & incidents in the entity's sidebar to see all detected incidents.

Each issue will be listed with its title and description (when available). Cortex will also display the status for an issue as a badge next to its name:

• Acknowledged

• Closed

• Detected

• Identified

• Investigating

• Mitigated

• Postmortem completed

• Postmortem started

• Resolved

• Started

The issue's severity will also appear in a badge (e.g. SEV0, SEV1, SEV2).

Trigger an incident

While viewing an entity in Cortex, you can trigger an incident in FireHydrant:

1. In Cortex, navigate to an entity. On the left side of an entity details page, click On-call & incidents.

2. In the upper right side of the entity's "On-call" page, click Trigger incident.

3. Configure the incident modal:

   • Summary: Enter a title for the incident.

   • Description: Enter a description of the incident.

   • Severity: Select a severity level.

   • Condition: Nature of the incident - Unavailable, Partially Unavailable, Degraded, Bug, or Operational.

4. At the bottom of the modal, click Trigger incident.

   • A confirmation screen will appear. In the confirmation, click the link to view the incident in FireHydrant.

Scorecards and CQL

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

See more examples in the CQL Explorer in Cortex.

Check if FireHydrant service is set

Check if entity has a registered FireHydrant service in its entity descriptor. If no registration exists, we'll try to automatically detect which corresponding FireHydrant service is associated with the entity.

Definition: firehydrant (==/!=) null

Example

For a Scorecard focused an production readiness, you can use this expression to make sure a FireHydrant service - and thus incident response - is defined for entities:

firehydrant != null

This is also a good way to make sure over time that FireHydrant is set up properly and reporting frequently.

Incidents

List of incidents, filterable on severity and status.

• Created at

• Description

• Impact condition name

• Name

• Severity

• Status

Definition: firehydrant.incidents()

Examples

For a Scorecard focused on service maturity or quality, you can use this expression to make sure there are no detected or identified FireHydrant incidents with a severity rating of 1 for a given entity:

firehydrant.incidents(severity = ["SEV1"], statuses = ["Detected", "Identified"]).length == 0

You can also tier severity-based rules to indicate progress over time. While the above rule might make sense in the first or second level, a higher-severity rule might make sense in a higher level:

firehydrant.incidents(severity = ["SEV3"], statuses = ["Detected", "Identified"]).length == 0

Still need help?​

The following options are available to get assistance from the Cortex Customer Engineering team:

• Email: [email protected], 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.