Skip to content

Explainer diagram of log formatting flow? #338

Description

@jpage-godaddy

Hello. I have a documentation suggestion. One thing that's not clear to me is the sequence and data flow of all of the custom logging settings. I'm wanting to do some Elastic Common Schema conformant logging, but it's not clear to me how everything ties together. A flow chart could do wonders! Examples of my doubts at a first reading of the docs:

  • Is genReqId called in all cases, even when customReceivedObject isn't present?
  • Do customSuccessObject and customErrorObject receive the object produced by customReceivedObject, or would I need to duplicate property extraction logic? Or does customReceivedObject change the request being passed to those functions?
  • Does customProps inject properties into the custom objects produced by custom*Object or do those functions supercede those?

I might try to source dive to figure this out myself, but maybe there's already a good explanation somewhere that could be better surfaced?

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions