0.1.33 • Published 18 days ago

@backstage/plugin-periskop v0.1.33

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
18 days ago

periskop

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

periskop-logo

Periskop aggregated errors

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

periskop-errors-card

Setup

  1. Configure the periskop backend plugin

  2. Install the plugin by running:

# From your Backstage root directory
cd packages/app
yarn add @backstage/plugin-periskop
  1. Add to the app EntityPage component:
// In packages/app/src/components/catalog/EntityPage.tsx
import { EntityPeriskopErrorsCard } from '@backstage/plugin-periskop';

const componentPage = (
  <EntityLayout>
    {/* other tabs... */}
    <EntityLayout.Route path="/periskop" title="Periskop">
      <Grid container spacing={3} alignItems="stretch">
        <Grid item xs={12} sm={12} md={12}>
          <EntityPeriskopErrorsCard />
        </Grid>
      </Grid>
    </EntityLayout.Route>
  1. Setup the app-config.yaml periskop block

  2. Annotate entities with the periskop service name

annotations:
  periskop.io/service-name: '<THE NAME OF THE PERISKOP APP>'
  1. Run app with yarn start and navigate to /periskop or a catalog entity 'Periskop' tab

Instances

The periskop plugin can be configured to fetch aggregated errors from multiple deployment instances.
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 instances 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:
  instances:
    - name: <name of the instance>
      url: <HTTP/S url for the Periskop instance's API>
0.1.33

21 days ago

0.1.32

24 days ago

0.1.32-next.1

1 month ago

0.1.32-next.0

1 month ago

0.1.31

1 month ago

0.1.30

2 months ago

0.1.29

2 months ago

0.1.29-next.2

2 months ago

0.1.29-next.1

2 months ago

0.1.29-next.0

2 months ago

0.1.28

3 months ago

0.1.28-next.3

3 months ago

0.1.28-next.2

3 months ago

0.1.28-next.1

3 months ago

0.1.28-next.0

4 months ago

0.1.27

4 months ago

0.1.27-next.2

4 months ago

0.1.27-next.1

4 months ago

0.1.27-next.0

5 months ago

0.1.26

5 months ago

0.1.26-next.3

5 months ago

0.1.26-next.2

5 months ago

0.1.26-next.1

5 months ago

0.1.18-next.2

10 months ago

0.1.18-next.1

10 months ago

0.1.19-next.0

10 months ago

0.1.24-next.1

6 months ago

0.1.24-next.2

6 months ago

0.1.24-next.0

7 months ago

0.1.19-next.2

9 months ago

0.1.19-next.1

9 months ago

0.1.23-next.2

7 months ago

0.1.23-next.1

7 months ago

0.1.23-next.0

8 months ago

0.1.21-next.0

9 months ago

0.1.22-next.2

8 months ago

0.1.22-next.1

8 months ago

0.1.22-next.3

8 months ago

0.1.26-next.0

6 months ago

0.1.20

9 months ago

0.1.21

9 months ago

0.1.22

8 months ago

0.1.23

7 months ago

0.1.24

6 months ago

0.1.25

6 months ago

0.1.18

10 months ago

0.1.19

9 months ago

0.1.18-next.0

11 months ago

0.1.17-next.2

11 months ago

0.1.17-next.3

11 months ago

0.1.17

11 months ago

0.1.16-next.2

1 year ago

0.1.16-next.1

1 year ago

0.1.17-next.1

12 months ago

0.1.17-next.0

12 months ago

0.1.16

12 months ago

0.1.15

1 year ago

0.1.16-next.0

1 year ago

0.1.15-next.3

1 year ago

0.1.13

1 year ago

0.1.14

1 year ago

0.1.15-next.2

1 year ago

0.1.15-next.1

1 year ago

0.1.15-next.0

1 year ago

0.1.14-next.2

1 year ago

0.1.14-next.1

1 year ago

0.1.14-next.0

1 year ago

0.1.13-next.0

1 year ago

0.1.13-next.1

1 year ago

0.1.13-next.2

1 year ago

0.1.12

1 year ago

0.1.12-next.1

1 year ago

0.1.12-next.2

1 year ago

0.1.10-next.3

1 year ago

0.1.10-next.2

1 year ago

0.1.10-next.1

1 year ago

0.1.10-next.0

1 year ago

0.1.10-next.4

1 year ago

0.1.10

1 year ago

0.1.11

1 year ago

0.1.12-next.0

1 year ago

0.1.9-next.0

2 years ago

0.1.9-next.1

2 years ago

0.1.8

2 years ago

0.1.9

1 year ago

0.1.8-next.2

2 years ago

0.1.8-next.1

2 years ago

0.1.8-next.0

2 years ago

0.1.7-next.2

2 years ago

0.1.7-next.0

2 years ago

0.1.7-next.1

2 years ago

0.1.7

2 years ago

0.1.5-next.2

2 years ago

0.1.5-next.3

2 years ago

0.1.5-next.0

2 years ago

0.1.5-next.1

2 years ago

0.1.4

2 years ago

0.1.6

2 years ago

0.1.5

2 years ago

0.1.6-next.1

2 years ago

0.1.4-next.0

2 years ago

0.1.4-next.1

2 years ago

0.1.6-next.0

2 years ago

0.1.3-next.2

2 years ago

0.1.3-next.1

2 years ago

0.1.3-next.0

2 years ago

0.1.3

2 years ago

0.1.2-next.1

2 years ago

0.1.2-next.0

2 years ago

0.1.0-next.0

2 years ago

0.1.0

2 years ago

0.1.2

2 years ago

0.1.1

2 years ago