opensafely-core / opensafely-core/backend-server

Document how to use query logs

Open
#303 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Shell
Stars
1
Forks
5
Avg merge
1h 36m
Merged PRs (30d)
2

Description

As a follow-up to #299, we should add some docs on how to send database query logs to Honeycomb, and how to interpret them. We said we'd do this in a few weeks time once we have more examples to check.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading issue #299 and reviewing the available database query-log examples for Honeycomb. Document how to send the logs and how to interpret them, with completion meaning that both workflows are explained clearly for users.

Written by the indexing model from the issue text.

Assessment

Domain
databases, documentation, observability-sre
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.