[3.x.x] Monitoring HTTP Access Logs doc needs to be updated

Open
#4,410 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Domain
documentation

Research direction

Start with the linked “Monitoring HTTP Access Logs” documentation section and review the access-log.properties examples and logging settings described in the issue. Update the 3.x.x guidance to reflect default log rotation and the shown disable configuration; determine whether the same change applies to 4.x.x before documenting it.

Written by the indexing model from the issue text.

Description

API-M-3.0.0 API-M-3.1.0 API-M-3.2.0 API-M-4.0.0 Docs/test help wanted Severity/Minor Type/Bug

In [1] we can no longer say it is disabled as it is enabled by default now
image

This incorrect, we can enable or disable log rotation by adding following to the access-log.properties file (created in step 3), log rotation is enabled by default now
nhttp.is.log.rotatable = true
image

To disable the logs we can set (this was set to info in step 1)

loggers = PassThroughAccess, ...

logger.PassThroughAccess.name = org.apache.synapse.transport.http.access
logger.PassThroughAccess.level = OFF

These changes should be applicable for all 3.x.x versions, 4.x.x was not tested but should be applicable best to test before doing the doc change for 4.x

[1] - https://apim.docs.wso2.com/en/3.0.0/administer/product-administration/monitoring/logging/monitoring-http-access-logs/#configuring-access-logs-for-passthrough-or-nio-transports-in-api-gateway

Dominant language
CSS
Stars
99
Forks
708
Avg merge
1d 7h
Merged PRs (30d)
22

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from wso2/docs-apim

All issues in wso2/docs-apim

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.