backstage/plugins/periskop/README.md

periskop

Periskop is a pull-based, language agnostic exception aggregator for microservice environments.

PeriskopErrorsTable

The Periskop Backstage Plugin exposes an entity tab component named PeriskopErrorsTable. Each of the entries in the table will direct you to the error details in your deployed Periskop instance location.

Now your plugin should be visible as a tab at the top of the entity pages. However, it warns of a missing periskop.io/name annotation.

Add the annotation to your component descriptor file as shown in the highlighted example below:

annotations:
  periskop.io/name: '<THE NAME OF THE PERISKOP APP>'

Locations

The periskop plugin can be configured to fetch aggregated errors from multiple deployment locations. This is especially useful if you have a multi-zone deployment, or a federated setup and would like to drill deeper into a single instance of the federation. Each of the configured locations will be included in the plugin's UI via a dropdown on the errors table.

The plugin requires to configure at least one Periskop API location in the app-config.yaml:

periskop:
  locations:
    - name: <name of the location>
      host: <HTTP/S host for the Periskop API location>