Kong / Kong/docs.konghq.com

file-log Plugin Document improvement

Open
#4,521 0 comments 0 reactions 0 assignees View on GitHub
papercut
Dominant language
Ruby
Stars
212
Forks
587
PR merge metrics
No merged PRs in 30d

Description

### Where is the problem?

https://docs.konghq.com/hub/kong-inc/file-log/

### What happened?

**Below are the points can be improved :**

- Latencies in the file log plugin doesn't show any time format whether it is in milliseconds/seconds .
- proxy is the time it took for the final service to process the request.

The above sentence can be improved grammatically.

### What did you expect to happen?

**Below are my expectation :**

### - Latencies should contain the time format :

latencies contains some data about the latencies involved:
proxy is the time it took for the final service to process the request in milliseconds.
kong is the internal Kong latency that it took to run all the plugins in milliseconds.
request is the time elapsed between the first bytes were read from the client and after the last bytes were sent to the
client in milliseconds.

### - Small correction
Original Sentence : proxy is the time it took for the final service to process the request.
My Expectation : proxy is the time taken by the final service to process the request.

### Code of Conduct and Community Expectations

- [X] I agree to follow this project's Code of Conduct
- [X] I agree to abide by the Community Expectations

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the file-log plugin page at https://docs.konghq.com/hub/kong-inc/file-log/ and inspect the latencies descriptions. Confirm the proxy, kong, and request values are identified as milliseconds and that the proxy sentence is grammatically improved; check the repository notice before making changes because this repository is archived and points to a replacement.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.