Update docs/plugins/observability.md

Co-authored-by: Adam Harvey <adam.harvey@dxc.com>
This commit is contained in:
Fredrik Adelöw
2021-02-01 19:06:30 +01:00
parent 77fe4ef3cd
commit 246c9c6edc
2 changed files with 36 additions and 1 deletions
+2
View File
@@ -218,6 +218,7 @@ Spotify
sqlite
squidfunk
src
stdout
stefanalund
subkey
subtree
@@ -258,6 +259,7 @@ Voi
Wealthsimple
Weaveworks
Webpack
winston
www
WWW
xyz
+34 -1
View File
@@ -5,7 +5,7 @@ title: Observability
description: Adding Observability to Your Plugin
---
This article briefly describes the observability option that are available to a
This article briefly describes the observability options that are available to a
Backstage integrator.
## Google Analytics
@@ -19,3 +19,36 @@ app:
```
Replace the tracking ID with your own.
For more information, learn about Google Analytics
[here](https://marketingplatform.google.com/about/analytics/).
## Logging
The backend supplies a central [winston](https://github.com/winstonjs/winston)
root logger that plugins are expected to use for their logging needs. In the
default production setup, it emits structured JSON logs on stdout, with a field
`"service": "backstage"` and also tagged on a per-plugin basis. Plugins that
want to more finely specify what part of their processes that emitted the log
message should add a `"component"` field to do so.
An example log line could look as follows:
```json
{
"service": "backstage",
"type": "plugin",
"plugin": "catalog",
"component": "catalog-all-locations-refresh",
"level": "info",
"message": "Locations Refresh: Refreshing location bootstrap:bootstrap"
}
```
## Health Checks
The example backend in the Backstage repository
[supplies](https://github.com/backstage/backstage/blob/bc18571b7a742863a770b2a54e785d6bbef7e184/packages/backend/src/index.ts#L99)
a very basic health check endpoint on the `/healthcheck` route. You may add such
a handler to your backend as well, and supply your own logic to it that fits
your particular health checking needs.