Skip to content

Added reference to android-log4j2 repo to the F.A.Q. #3643

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

Open
wants to merge 1 commit into
base: 2.x
Choose a base branch
from

Conversation

neboskreb
Copy link
Contributor

Added reference to android-log4j2 repo to the F.A.Q.

FYI @ppkarwasz

@ppkarwasz
Copy link
Contributor

Hi @neboskreb,

Looking more closely at android-log4j2, it is not an implementation of the Log4j API, but a set of Log4j Core plugins to enhance user experience on Android right?

In this case I would:

  • just add a short AsciiDoc note below the Log4j Core entry:
    You should use `BasicContextSelector` (default on Android) or `BasicAsyncLoggerContextSelector` instead.

    that simply says "For a better experience on Android, see the third-party Log4j2 in Android project". The "third-party" word is essential here, since the ASF can not endorse third-party software.
  • add an "Android Lookup" section to the Third-party lookups section. The order is alphabetical and the entry should contain enough information to understand what the lookup does, but delegate to your own documentation, so it does not need to be changed at each release.
  • add the fully qualified name of the "Android Context Selector" to the Context Selector section of our website. There is a subsection for third-party context selectors.
  • we don't have a "third-party appenders" section yet, but you can probably create such a section in the appenders page or create a new page with third-party appenders. @grobmeier, what is the best approach?

@ppkarwasz ppkarwasz moved this from To triage to Waiting for user in Log4j bug tracker Apr 29, 2025
@ppkarwasz ppkarwasz added the waiting-for-user More information is needed from the user label Apr 29, 2025
@neboskreb
Copy link
Contributor Author

Thanks for the input, @ppkarwasz

To be honest, I didn't expect that a simple workaround proposition which I put forward transforms into such a big scope.

Android-log4j is not something I actively promote. It was just something I needed for my hobby project, and having been unable to find a working library in the whole internet, I decided once I have to code it for myself, I could share it with others - that's the whole of my motivation. My immediate goal is achieved - I've got the library working. For the others - well, as this is the only working lib for Android, I guess that's worth giving a try...

So yeah, it would be great to get a grain of glory to be listed in Log4J docs. I could do the most of writing, but my experience with Log4J is very limited (I genuinely didn't know what "lookups" are until you mentioned them) so I will need your help reviewing and rectifying my writing...

So the question is: do you have enough free time and patience to go into it?

@ppkarwasz
Copy link
Contributor

Android-log4j is not something I actively promote. It was just something I needed for my hobby project, and having been unable to find a working library in the whole internet, I decided once I have to code it for myself, I could share it with others - that's the whole of my motivation. My immediate goal is achieved - I've got the library working. For the others - well, as this is the only working lib for Android, I guess that's worth giving a try..

Thanks for sharing the project with the community. My philosophy on this is that if you share a project, someone might as well use it. This unfortunately requires some marketing and spending time on documentation, but it can result in users contributing back to the project.

So yeah, it would be great to get a grain of glory to be listed in Log4J docs. I could do the most of writing, but my experience with Log4J is very limited (I genuinely didn't know what "lookups" are until you mentioned them) so I will need your help reviewing and rectifying my writing...

So the question is: do you have enough free time and patience to go into it?

Right now I don't have a lot of time, but we can update our documentation at any moment, so this task is not time sensitive.

What is time sensitive is the PR #3638, because we need to wait for a release to change log4j-api.

@neboskreb
Copy link
Contributor Author

Glad to know we're on the same page, @ppkarwasz ! I shall draft the chapters you mentioned and you will review/finalize it when time permits.

Regarding #3638, what exactly should be done there to unblock it? Let's move this discussion into that ticket.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
waiting-for-user More information is needed from the user
Projects
Status: Waiting for user
Development

Successfully merging this pull request may close these issues.

2 participants