Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use structured logging in core-amqp #25671

Merged
merged 17 commits into from
Jan 11, 2022
Merged

Use structured logging in core-amqp #25671

merged 17 commits into from
Jan 11, 2022

Conversation

lmolkova
Copy link
Member

@lmolkova lmolkova commented Nov 24, 2021

Switch to structured logging in AMQP Core

Structured logging TL;DR: we represent message as json string for logs with context

Before:

logger = new ClientLogger(ReceiveLinkHandler.class);
logger.info("connectionId[{}] linkName[{}] entityPath[{}] Receiver link was never active. Closing endpoint "
      + "states.", getConnectionId(), getLinkName(), entityPath);

2021-10-01 06:32:42,732 INFO [com.azure.core.amqp.implementation.handler.ReceiveLinkHandler] (reactor-executor-183) connectionId[MF_c991bc_1632981438863] linkName[session-_368299_1633069903838] entityPath[pms-restrictions] Receiver link was never active. Closing endpoint states.

After:

logger = new ClientLogger(ReceiveLinkHandler.class, Map.of(CONNECTION_ID_KEY, connectionId));
logger.atInfo()
        .addKeyValue(ENTITY_PATH_KEY, entityPath)
        .addKeyValue(LINK_NAME_KEY, linkName)
        .log("Receiver link was never active. Closing endpoint states");

2021-10-01 06:32:42,732 INFO [com.azure.core.amqp.implementation.handler.ReceiveLinkHandler] (reactor-executor-183) {"az.sdk.message": "Receiver link was never active. Closing endpoint states", "connectionId":"MF_c991bc_1632981438863", "linkName":"session-_368299_1633069903838", "entityPath":"pms-restrictions"}

Context: https://gist.github.com/lmolkova/04f6484595fdd7edded9f4d82619291f

TODO:

  • AmqpLoggingUtils docs and tests

@ghost ghost added the Azure.Core azure-core label Nov 24, 2021
@lmolkova lmolkova mentioned this pull request Nov 25, 2021
1 task
@lmolkova lmolkova changed the title Use structured logging in amqp-core Use structured logging in core-amqp Dec 1, 2021
@lmolkova lmolkova marked this pull request as ready for review December 1, 2021 23:43
@azure-sdk
Copy link
Collaborator

API changes have been detected in com.azure:azure-core. You can review API changes here

API changes

+         public static <T> Mono<T> monoError(LoggingEventBuilder logBuilder, RuntimeException ex) 

@JonathanGiles
Copy link
Member

image

@check-enforcer
Copy link

check-enforcer bot commented Dec 3, 2021

This pull request is protected by Check Enforcer.

What is Check Enforcer?

Check Enforcer helps ensure all pull requests are covered by at least one check-run (typically an Azure Pipeline). When all check-runs associated with this pull request pass then Check Enforcer itself will pass.

Why am I getting this message?

You are getting this message because Check Enforcer did not detect any check-runs being associated with this pull request within five minutes. This may indicate that your pull request is not covered by any pipelines and so Check Enforcer is correctly blocking the pull request being merged.

What should I do now?

If the check-enforcer check-run is not passing and all other check-runs associated with this PR are passing (excluding license-cla) then you could try telling Check Enforcer to evaluate your pull request again. You can do this by adding a comment to this pull request as follows:
/check-enforcer evaluate
Typically evaulation only takes a few seconds. If you know that your pull request is not covered by a pipeline and this is expected you can override Check Enforcer using the following command:
/check-enforcer override
Note that using the override command triggers alerts so that follow-up investigations can occur (PRs still need to be approved as normal).

What if I am onboarding a new service?

Often, new services do not have validation pipelines associated with them, in order to bootstrap pipelines for a new service, you can issue the following command as a pull request comment:
/azp run prepare-pipelines
This will run a pipeline that analyzes the source tree and creates the pipelines necessary to build and validate your pull request. Once the pipeline has been created you can trigger the pipeline using the following comment:
/azp run java - [service] - ci

@joshfree joshfree added amqp Label for tracking issues related to AMQP feature-request This issue requires a new behavior in the product in order be resolved. labels Dec 3, 2021
@azure-sdk
Copy link
Collaborator

API changes have been detected in com.azure:azure-core. You can review API changes here

API changes

+         public static <T> Mono<T> monoError(LoggingEventBuilder logBuilder, RuntimeException ex) 

@lmolkova lmolkova merged commit b1569cd into Azure:main Jan 11, 2022
samvaity pushed a commit to samvaity/azure-sdk-for-java that referenced this pull request Jan 11, 2022
* Switch to structured logging in azure-core-amqp
samvaity pushed a commit to samvaity/azure-sdk-for-java that referenced this pull request Jan 11, 2022
* Switch to structured logging in azure-core-amqp
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
amqp Label for tracking issues related to AMQP Azure.Core azure-core feature-request This issue requires a new behavior in the product in order be resolved.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants