Skip to content

docs: enhance access log fields with comprehensive Envoy field documentation #1898

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: main
Choose a base branch
from

Conversation

desimone
Copy link
Collaborator

@desimone desimone commented Jun 28, 2025

Summary

Enhanced the access log fields documentation to include comprehensive Envoy access log field capabilities as requested in #1605.

Changes

  • Extended field documentation: Added 15+ new Envoy-specific access log fields
  • Organized field categories: Grouped fields into Standard, Extended Envoy, and Custom sections
  • Enhanced examples: Added configuration examples for extended Envoy fields across all deployment types
  • Use case guidance: Added section explaining when and how to use extended fields for performance monitoring and debugging
  • Example output: Provided realistic log examples showing extended fields in action

New Fields Added

  • Performance fields: request-duration, response-duration, upstream-response-time
  • Connection fields: downstream-local-address, upstream-host, protocol
  • Debugging fields: response-flags, route-name, upstream-request-attempt-count
  • And many more for comprehensive observability

Related Issues

/cc @kralicky for review

…ntation

- Add extensive set of Envoy access log fields with detailed descriptions
- Organize fields into Standard, Extended Envoy, and Custom categories
- Add configuration examples for extended Envoy fields
- Include performance monitoring and debugging use cases
- Add example log output with extended fields
- Provide guidance on using timing fields for performance optimization

Fixes #1605
@desimone desimone requested a review from a team as a code owner June 28, 2025 04:45
@desimone desimone requested review from kenjenkins and removed request for a team June 28, 2025 04:45
Copy link

netlify bot commented Jun 28, 2025

Deploy Preview for pomerium-docs ready!

Name Link
🔨 Latest commit 7b7dae6
🔍 Latest deploy log https://app.netlify.com/projects/pomerium-docs/deploys/685f7386b733180008191327
😎 Deploy Preview https://deploy-preview-1898--pomerium-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Comment on lines +62 to +64
- protocol
- upstream-response-time
- response-flags
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think these fields are currently supported:

{
  "level": "error",
  "config-change-id": "0fbca6a4-eb1d-468e-a5e1-0cc31b2e317d",
  "error": "config: options from config file \".config.yaml\": validation error config: invalid access_log_fields: unknown access log field: response-flags",
  "time": "2025-06-30T11:48:57-07:00",
  "message": "config: error updating config"
}


### Extended Envoy Fields

These additional fields are available through Envoy's access logging system:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does this mean? None of these are in the list of access log fields we support.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document Envoy access log fields
3 participants