Skip to content

Commit ff433a8

Browse files
docs: Change headings in configure-logging.md to H2 (#1282)
These will no longer be present in the docs index
1 parent 8cd8301 commit ff433a8

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

‎docs/how-to/configure-logging.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ By default BlueAPI will log to stdout at the [INFO level](https://docs.python.or
55

66
When logging to [Graylog](https://graylog.org) is enabled, BlueAPI will also continue to log to stdout.
77

8-
# BlueAPI Cofiguration
8+
## BlueAPI Cofiguration
99

1010
:::{seealso}
1111
[Configure the Application](./configure-app.md)
@@ -18,7 +18,7 @@ An example logging config is shown below:
1818

1919
With this configuration, all logs at INFO level or above will be logged to both stdout and the configured graylog.
2020

21-
# Instrumenting Libraries
21+
## Instrumenting Libraries
2222
To instrument to a custom module in BlueAPI, instantiate a logger from the [standard library logging package, then use any of its log methods](https://docs.python.org/3/library/logging.html#logger-objects).
2323

2424
BlueAPI is configured to handle logging from any python code it executes.
@@ -29,22 +29,22 @@ LOGGER = logging.getLogger(__name__)
2929
LOGGER.info("FOO")
3030
```
3131

32-
# Kubernetes
32+
## Kubernetes
3333

3434
Services hosted on the DLS clusters automatically have their stdout forwarded to Graylog via a service called fluentd. Due to this, BlueAPI services hosted on the cluster will always log to Graylog.
3535

3636
When BlueAPI's native Graylog support is enabled it forwards structured data rather than plaintext.
3737

3838
When BlueAPI's native Graylog is enabled fluentd will be automatically disabled to avoid log duplication.
3939

40-
# Where to Find Logs
40+
## Where to Find Logs
4141

4242
By default logs can be found wherever your stdout is.
4343

4444
If Graylog is enabled, logs will be forwarded to whichever Graylog instance the configuration addresses. By default this is the main Diamond instance, which can be accessed via [graylog.diamond.ac.uk](https://graylog.diamond.ac.uk/)
4545

4646
If your BlueAPI server is running on the Diamond cluster, stdout is likely being forwarded to the above Graylog instance.
4747

48-
# Log Message Structure
48+
## Log Message Structure
4949

5050
When structured logging via Graylog is enabled, BlueAPI will bundle the log message and instrument name (e.g. i22) into a JSON blob. Also included is other standard logging data, such as a timestamp.

0 commit comments

Comments
 (0)