zowe / zowe/api-layer

OTel - Log signal for successfully routed anonymous requests

Open
#4,704 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement stale
Dominant language
Java
Stars
92
Forks
81
Avg merge
1d 9h
Merged PRs (30d)
46

Description

When APIML successfully (the service is onboarded) routes an anonymous request (without any authentication) to a donwnstream service, produce a log signal with attributes:

  • time of event (timestamp)
  • apiml url path (url.path)
  • apiml url scheme (url.scheme)
  • apiml http method (http.request.method)
  • apiml error type (error.type)
  • apiml error message (error.message)
  • user id (user.id)
  • service id (service.id)
  • service instance id (service.instance.id)
  • service response code (service.response.status_code)
Acceptance criteria:
  • If the request does not have a User ID (e.g., an unauthenticated public endpoint):
    • The user.id attribute should be recorded as "anonymous", rather than preventing the log generation.
  • Acceptance tests
  • Documentation updated

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

Start by tracing the APIML path that routes successfully onboarded anonymous requests and reviewing the existing OpenTelemetry logging behavior. Add the specified event attributes, ensure missing user IDs are recorded as "anonymous," then add acceptance tests and update the documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, backend, documentation, observability, testing
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.