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

Revamp the Lookups page #2526

Closed
vy opened this issue Apr 26, 2024 · 0 comments · Fixed by #2736
Closed

Revamp the Lookups page #2526

vy opened this issue Apr 26, 2024 · 0 comments · Fixed by #2736
Assignees
Labels
documentation Pull requests or issues that affect documentation

Comments

@vy
Copy link
Member

vy commented Apr 26, 2024

As agreed in the site structure document, revamp the "Development" page such that

  • Outline:
    • What is a lookup?
      • Also explain the interpolation difference between configuration and runtime
      • List lookups + link to plugin reference pages
    • Extending lookups
  • Target 2.x, port to main

Interpolation rules

Interpolation rules of lookups in different places are very complicated. Consider following cases:

  • ${foo} passed to <JsonTemplateLayout in log4j2.xml
  • $${foo} passed to <JsonTemplateLayout in log4j2.xml
  • ${foo} passed to <JsonTemplateLayout in an event template configuration file (e.g., FooLayout.json)
  • $${foo} passed to <JsonTemplateLayout in an event template configuration file (e.g., FooLayout.json)
  • ${foo} passed to <EventTemplateAdditionalField of <JsonTemplateLayout in log4j2.xml
  • $${foo} passed to <EventTemplateAdditionalField of <JsonTemplateLayout in log4j2.xml
  • ${foo} passed to JsonTemplateLayout.Builder in an event template configuration file programmatically
  • $${foo} passed to JsonTemplateLayout.Builder in an event template configuration file programmatically

We should provide assistance to guide users in these cases, document, and verify(!) them.

Lookups vs property substitution

In several places of the document, lookups and property substitution are used interchangeably, even though they are not. We should clarify this ambiguity, in particular, in layouts.

@vy vy added the documentation Pull requests or issues that affect documentation label Apr 26, 2024
@ppkarwasz ppkarwasz self-assigned this Jul 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Pull requests or issues that affect documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants