https://github.com/willscott/go-requestcontext

keep a request id on a context
https://github.com/willscott/go-requestcontext

Last synced: about 1 year ago
JSON representation

keep a request id on a context

• Host: GitHub
• URL: https://github.com/willscott/go-requestcontext
• Owner: willscott
• License: other
• Created: 2023-07-21T08:26:05.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-07-21T08:26:45.000Z (almost 3 years ago)
• Last Synced: 2025-02-06T10:19:50.979Z (over 1 year ago)
• Language: Go
• Size: 5.86 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# go-requestcontext

This repo provides a small shim for tagging a request ID onto the request context, and then get access to that request ID in sub-contexts.

The impetus for this code is that the setting and use of the request ID context key may be in different projects, and it may be desirable to decouple the dependency between such projects. Since context keys are advisted to be set using a custom sentinal type, this repo provides the place for that singleton value to live.

## Usage

```go

import (

    "context"

    "net/http"

    requestcontext "github.com/willscott/go-requestcontext"

)

func main() {

    // Injection

    mux := http.NewServeMux()

    handler := requestcontext.Middleware(mux, "X-RequestID")

    ...

}

func sendSubrequest(ctx context.Context) {

    rid := requestcontext.IDFromContext(ctx)

    ...

}

```

## Documentation

See [godoc](https://godoc.org/github.com/willscott/go-requestcontext) for API documentation.

## Contributing

Contributions are welcome! This repository is part of the IPFS project and therefore governed by our [contributing guidelines](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md).

## License

[SPDX-License-Identifier: Apache-2.0 OR MIT](LICENSE.md)