OpenConext / OpenConext/OpenConext-engineblock

Add RequestId headers to http responses and logs

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

Nobody has claimed this yet.

logging
Dominant language
PHP
Stars
17
Forks
25
Avg merge
4d 1h
Merged PRs (30d)
1

Description

For each HTTP request that is handled:

  • generate a unique random id
  • add this request ID to all log lines that are triggered during handling of this request
  • add this request ID to as a X-OpenConext-Request-Id (TODO: Check what format Stepup uses, discuss what makes sense) header in the http response header.

This (together the the correlation id and session id) will allow us to trace authentication requests throughout the application flow.

The OpenConext is there to prevent name clash with other apps that might set a "Request-Id"

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 locating the HTTP request handling and logging paths in the repository, then check how Stepup formats its request identifiers. Done means each handled request has a unique ID in all triggered log lines and in the X-OpenConext-Request-Id response header, with the identifier format agreed.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
api, authentication, backend, observability
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.