wu-sheng commented on a change in pull request #6183:
URL: https://github.com/apache/skywalking/pull/6183#discussion_r569474059



##########
File path: docs/en/concepts-and-designs/event.md
##########
@@ -0,0 +1,56 @@
+# Events
+
+SkyWalking already supports the three pillars of observability, namely logs, 
metrics, and traces.
+In reality, a production system experiences many other events that may affect 
the performance of the system, such as upgrading, rebooting, chaos testing, etc.
+Although some of these events are reflected in the logs, there are many other 
events that can not. Hence, SkyWalking provides a more native way to collect 
these events.
+This doc covers the design of how SkyWalking collects events and what events 
look like in SkyWalking.
+
+## How to Report Events
+
+SkyWalking backend supports three protocols to collect events, gRPC, HTTP, and 
Kafka. Any agent or CLI that implements one of these protocols can report 
events to SkyWalking.
+Currently, the officially supported clients to report events are:
+
+- [ ] Java Agent Toolkit: Use the Java agent toolkit to report events from 
inside the applications.
+- [x] SkyWalking CLI: Use the CLI to report events from the command line 
interface.
+- [ ] Kubernetes Event Exporter: Deploy an event exporter to refine and report 
Kubernetes events.
+
+## Event Definition
+
+An event contains the following fields. The definitions of event can be found 
at the [protocol repo](#TODO)

Review comment:
       Please finish this TODO




----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
[email protected]


Reply via email to