Log Signal Examples and Attribute Mapping

The following scenarios represent common log signals emitted by API ML. Each example includes the specific attributes present in the signal body and the resulting JSON payload.

A Service registered successfully to Eureka (API ML - Discovery Service)

This signal is emitted when an onboarded service instance successfully registers its metadata with the Discovery Service registry.

• http.request.method
  The HTTP verb (POST).
• service.id
  The logical ID of the Discovery service.
• service.instance.id
  The specific host and port of the Discovery instance.
• service.response_code
  The status returned by the registry (204).
• url.path
  The Eureka registration endpoint.
• url.scheme
  The communication protocol (https).

{
  "http.request.method": "POST",
  "service.id": "discovery",
  "service.instance.id": "localhost:discovery:10011",
  "service.response_code": "204",
  "url.path": "/eureka/apps/<service Id>",
  "url.scheme": "https"
}

This signal confirms that the onboarding is accepted by the Discovery Service.

A Service sent a successful heartbeat

This signal indicates that an active service instance has successfully renewed its lease with the Discovery Service to maintain its availability status.

• http.request.method
  The HTTP verb (PUT).

• service.id
  The logical ID of the target service.

• service.instance.id
  The specific instance sending the heartbeat.

• service.response_code
  The status of the heartbeat renewal (200).

• url.path
  The specific Eureka instance lease renewal path.

• url.scheme
  The communication protocol (https).

{
  "http.request.method": "PUT",
  "service.id": "discovery",
  "service.instance.id": "localhost:discovery:10011",
  "service.response_code": "200",
  "url.path": "/eureka/apps/<service Id>/localhost:<service Id>:10012",
  "url.scheme": "https"
}

This signal confirms the Discovery Service received the health information from the service (service Id)

A successful login attempt

This signal captures a successful authentication event initiated by a user through the API ML Gateway login endpoint.

• http.request.method
  The HTTP verb (POST).

• service.id
  The logical ID for the Gateway.

• service.instance.id
  The Gateway instance handling the authentication.

• service.response_code
  The status of the login request (204).

• url.path
  The authentication login endpoint.

• url.scheme
  The communication protocol (https).

{
  "http.request.method": "POST",
  "service.id": "gateway",
  "service.instance.id": "localhost:gateway:10010",
  "service.response_code": "204",
  "url.path": "/gateway/api/v1/auth/login",
  "url.scheme": "https"
}

This signal confirms that the Gateway has successfully validated the inbound client credentials, establishing the active session required to authorize subsequent routed API requests.

A successful request to API ML (authenticated but not populating information)

This signal represents a successful, authenticated request to the API Catalog service, typically used for retrieving container or service metadata. While the status indicates a successful transaction, this signal is frequently used to troubleshoot scenarios where the request is valid but the resulting response contains an empty data set.

• http.request.method
  The HTTP verb (GET).

• service.id
  The logical ID of the API Catalog.

• service.instance.id
  The instance providing catalog data.

• service.response_code
  The success status (200).

• url.path
  The endpoint for retrieving containers.

• url.scheme
  The communication protocol (https).

{
  "http.request.method": "GET",
  "service.id": "apicatalog",
  "service.instance.id": "localhost:apicatalog:10010",
  "service.response_code": "200",
  "url.path": "/apicatalog/api/v1/containers",
  "url.scheme": "https"
}

This signal confirms that the API Catalog communication layer and authentication are working correctly, and that the empty response is due to an empty service registry rather than a system connectivity failure.

Valid authentication when routing to an onboarded service (JWT)

This signal describes a request successfully authenticated via a Zowe JWT that has been routed to a downstream onboarded service.

• auth.method
  The general authentication type (JWT).

• auth.service.auth.method
  The specific Zowe provider (zoweJwt).

• auth.status
  The final result of authentication (OK).

• http.request.method
  The HTTP verb (GET).

• service.id
  The logical ID of the Zowe JWT service.

• service.instance.id
  The unique service instance identifier.

• service.response_code
  The successful status code (200).

• url.path
  The routed request endpoint.

• url.scheme
  The communication protocol (https).

• user.id
  The identifier of the authenticated user.

{
  "auth.method": "JWT",
  "auth.service.auth.method": "zoweJwt",
  "auth.status": "OK",
  "http.request.method": "GET",
  "service.id": "zowejwt",
  "service.instance.id": "static-localhost:zowejwt:10012",
  "service.response_code": "200",
  "url.path": "/zowejwt/api/v1/request",
  "url.scheme": "https",
  "user.id": "USER"
}

This signal verifies an end-to-end successful transaction where the user's identity was validated via token and securely propagated to the target downstream microservice.

Invalid authentication when routing to an onboarded service (JWT)

This signal describes a request with an expired Zowe JWT token that was routed to a downstream onboarded service.

• auth.service.auth.method The specific Zowe provider (zoweJwt).

• auth.status The final result of authentication (ERROR).

• auth.error.message A description of the error message.

• auth.error.type Type of error.

• http.request.method The HTTP verb (GET).

• service.id The logical ID of the Zowe JWT service.

• service.instance.id The unique service instance identifier.

• service.response_code The successful status code (401).

• url.path The routed request endpoint.

• url.scheme The communication protocol (https).

The following example presents the payload when an expired token has been used.

Example:

{
 "auth.service.auth.method": "zoweJwt",
 "auth.status": "ERROR",
 "auth.error.message": "ZWEAO402E The request has not been applied because it lacks valid authentication credentials.",
 "auth.error.type": "org.zowe.apiml.security.common.token.TokenExpireException",
 "http.request.method": "GET",
 "service.id": "<service Id>",
 "service.instance.id": "static-localhost:<service Id>:10012",
 "service.response_code": "401",
 "url.path": "/<service Id>/api/v1/request",
 "url.scheme": "https"
}

This signal confirms that while the API ML failed to validate the authentication credentials, the Gateway still routed the request downstream, resulting in the target service (zowejwt) rejecting the request with a 401 unauthorized response.