Skip to content

Allow full control over log output format #33

@nicmunroe

Description

@nicmunroe

Users might want to fully control the log message output of distributed traces. To allow for this, SpanLoggingRepresentation should be refactored to an interface (with the existing JSON and KEY_VALUE enums continuing as available options people can use). Then Tracer.completeAndLogSpan() should be refactored to delegate the log message to the interface so that users can fully define the log message and format themselves if desired.

One possible solution:

  • Rename SpanLoggingRepresentation into an interface named SpanLoggingStrategy.
  • The SpanLoggingStrategy interface should have a single method: SpanLoggingStrategy.logCompletedSpan(Span completedSpan, Logger loggerToUse, String infoTag).
  • Tracer.completeAndLogSpan() should delegate to whatever SpanLoggingStrategy is registered with it by replacing the loggerToUse.info(...) line with the new SpanLoggingStrategy method call.
  • Migrate the existing JSON and KEY_VALUE SpanLoggingRepresentation enum values to a different enum named DefaultSpanLoggingStrategyOptions that implements SpanLoggingStrategy and results in the same log messages we see with the current code.

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