> For the complete documentation index, see [llms.txt](https://developer.harness.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.harness.io/internal-developer-portal/use-idp/plugins/available-plugins/rootly.md).

# Rootly

| Plugin details |                                                        |
| -------------- | ------------------------------------------------------ |
| **Created by** | [rootly](https://rootly.com/)                          |
| **Category**   | Monitoring                                             |
| **Source**     | [GitHub](https://github.com/rootlyhq/backstage-plugin) |
| **Type**       | Open-source plugin                                     |

### Configuration <a href="#configuration" id="configuration"></a>

#### Application configuration YAML <a href="#application-configuration-yaml" id="application-configuration-yaml"></a>

* Under the **Plugins** tab in **Configure**, go to `app-config.yaml` and **Edit YAML** to configure the proxy endpoint and allow the frontend to authenticate with Rootly without exposing your API key to users.

![](/files/Zy4ze7Kjs99NVswBPeEk)

#### Secrets <a href="#secrets" id="secrets"></a>

#### Create an Rootly API key <a href="#create-an-rootly-api-key" id="create-an-rootly-api-key"></a>

Because of the features provided by the plugin, an API key with full access to your Rootly domain is required.

* Read access on services is needed to list services, write access to link entities to services.
* Read access on incidents needed to list incidents.

1. Go to **Profile** → **Manage API Keys**.
2. Click on **Generate New API Key** button.
3. Copy the key.

![](/files/4VkihvHm8DI8X1SWckiS)

### Layout <a href="#layout" id="layout"></a>

This plugin exports a page, a tab and a UI card that you can show on the **Overview** tab of a service or any other layout page. The following configuration is set by default in **Layout** under **Configure** for **Service** and you do not need to change anything:

```yaml
- component: RootlyOverviewCard
          specs:
            gridProps:
              md: 6
- name: RootlyIncidentsPage
    path: /rootly
    title: Rootly
    contents:
    - component: RootlyIncidentsPage
```

![](/files/Zy4ze7Kjs99NVswBPeEk)

### Annotations <a href="#annotations" id="annotations"></a>

To configure the plugin for a service in the software catalog, set one of the following annotations in its `catalog-info.yaml` definition file.

The following configuration is recommended:

```yaml
rootly.com/service-id: 7a328a08-6701-445e-a1ad-ca2fb913ed1e # Use service-id or service-slug. Not both.
rootly.com/service-slug: elasticsearch-staging # Use service-id or service-slug. Not both.
rootly.com/service-auto-import: enabled # This will auto import the entity as a rootly service if we do not find any.
```

[Read more](https://github.com/rootlyhq/backstage-plugin?tab=readme-ov-file#annotations)

### Support <a href="#support" id="support"></a>

The plugin is owned by Rootly and managed in the [repository](https://github.com/rootlyhq/backstage-plugin) as an open-source project. Create a GitHub issue to report bugs or suggest new features for the plugin.