Skip to content

Enhance Logger Middleware Documentation with Detailed Configuration Examples #2665

@lscannon12

Description

@lscannon12

Issue Description

The current documentation for the Logger middleware in the Echo framework is insufficient. It lacks detailed explanations of configuration options and comprehensive examples for various use cases. This makes it difficult for new users to fully understand and utilize the middleware’s capabilities.

Checklist

  • Dependencies installed
  • No typos
  • Searched existing issues and docs

Expected behaviour

The Logger middleware documentation should provide clear and detailed explanations for each configuration option. It should include comprehensive examples covering various use cases such as logging different request/response details, customizing log formats, and integrating with external logging services. Additionally, troubleshooting tips for common issues should be included.

Actual behaviour

The current documentation provides a basic example but lacks detailed explanations and comprehensive examples. This makes it challenging for users to understand how to fully utilize the Logger middleware.

Steps to reproduce

  1. Attempt to figure out Logger middleware using current examples
  2. Note the lack of detailed explanations, which may be a learning curve for new users.

Version/commit

Echo version: v4.12.0
Go version: 1.17.0
Operating System: MacOS

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions