opensafely / opensafely/documentation

Log search queries in Analytics

Open
#2,046 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
48
Forks
10
Avg merge
2d 19h
Merged PRs (30d)
17

Description

So that we can figure out where gaps in our documentation is.

Things to consider:

  1. Should we log all requests, or a sample of requests?
  2. Should we log when input is paused, or only when a result is clicked on?
    1. What if they don't find what they are looking for?
    2. Do we also check when the input focus is removed?
  3. Do we need to update the privacy policy to reflect this change?
    1. Do we need to consider how to redact data?

Contributor guide

Open the contributing guide

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

No files, tests, or entry points are named. Start by resolving whether to log all requests or a sample, which user actions count, and how privacy policy and redaction should be handled. Done means the logging scope, privacy requirements, and implementation plan are agreed.

Written by the indexing model from the issue text.

Assessment

Domain
analytics
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Active
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.