Anonymitaet opened a new issue, #19776: URL: https://github.com/apache/pulsar/issues/19776
### Search before asking - [X] I searched in the [issues](https://github.com/apache/pulsar/issues) and found nothing similar. ### What issue do you find in Pulsar docs? Reported by @codelipenghui: We donโt have any documentation on how to enable the structured log. ### What is your suggestion? Hi @ivankelly, We (+@zymap) see you developed the feature of [structured event logging](https://github.com/apache/pulsar/pull/11800). Some users are asking how to use this feature, so we plan to add docs for it. Not sure if we understand this feature correctly. Can you help check the plan and answer the questions below? Thank you! ๐น๐น๐น ### โ๏ธ High-level IA This information architecture is designed to add the missing docs and consolidate relevant docs: <img width="1211" alt="image" src="https://user-images.githubusercontent.com/50226895/224213125-7bb6fec0-80c9-458e-b0ef-8dda7e5730b0.png";> ### โ๏ธ Detailed explanations ========================= โ 1.1 Action: Create an `Observability` guide. 1.2 Reason: From a functionality perspective, `Structured Event Logging` belongs to `Observability`. So this guide can be created, which is in parallel to other existing guides like [Get Started](https://pulsar.apache.org/docs/next/getting-started-home/). ========================= โ 2.1 Action: Move chapters of the [Metrics](https://pulsar.apache.org/docs/next/reference-metrics/), [Stas](https://pulsar.apache.org/docs/next/administration-stats/) , and [Monitoring ](https://pulsar.apache.org/docs/next/deploy-monitoring/) chapters to the `Observability` guide. 2.2 Reasons: - From a functionality perspective, these chapters should go into the `Observability` guide. - Relocate them firstly as a low-hanging fruit and quick win. It's an imperfect plan (because the content in these 3 chapters can be improved and consolidated more logically), but we can optimize it later. ========================= โ 3.1 Action: Generate API reference for `Structured Event Logging`. 3.2 Concern: Not sure if [API references for `Structured Event Logging`](https://repo1.maven.org/maven2/org/apache/pulsar/structured-event-log/) should be exposed to users? Or no need since it's an inbound feature in brokers? <img width="901" alt="image" src="https://user-images.githubusercontent.com/50226895/224211709-b2cc2688-e50a-4d79-8787-adc866cf7ec4.png";> ๐น๐น๐น cc @momo-jun @DaveDuggins @D-2-Ed ### Any reference? Doc references: - [RabbitMQ - Logging](https://www.rabbitmq.com/logging.html) - [CloudAMQP Logs](https://www.cloudamqp.com/docs/cloudamqp-log.html) ### Are you willing to submit a PR? - [ ] I'm willing to submit a PR! -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
![https://user-images.githubusercontent.com/50226895/224213125-7bb6fec0-80c9-458e-b0ef-8dda7e5730b0.png"](https://user-images.githubusercontent.com/50226895/224213125-7bb6fec0-80c9-458e-b0ef-8dda7e5730b0.png"){kind=link}
![https://user-images.githubusercontent.com/50226895/224211709-b2cc2688-e50a-4d79-8787-adc866cf7ec4.png"](https://user-images.githubusercontent.com/50226895/224211709-b2cc2688-e50a-4d79-8787-adc866cf7ec4.png"){kind=link}