Skip to content

docs: Change headings in configure-logging.md to H3 #1282

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dan-fernandes wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: Change headings in configure-logging.md to H3 #1282

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
277d993
Change headings in configure-logging.md to H3
dan-fernandes Nov 24, 2025
0fe41f2
Merge branch 'main' into change-docs-headings
dan-fernandes Dec 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/how-to/configure-logging.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ By default BlueAPI will log to stdout at the [INFO level](https://docs.python.or

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

# BlueAPI Cofiguration
### BlueAPI Cofiguration

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

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

# Instrumenting Libraries
### Instrumenting Libraries
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).

BlueAPI is configured to handle logging from any python code it executes.
Expand All @@ -29,22 +29,22 @@ logger = logging.getLogger(__name__)
logger.info("FOO")
```

# Kubernetes
### Kubernetes

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.

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

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

# Where to Find Logs
### Where to Find Logs

By default logs can be found wherever your stdout is.

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/)

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

# Log Message Structure
### Log Message Structure

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.
Loading