From 67b62db52455da6b23966d37fcca2bd1ebe466f2 Mon Sep 17 00:00:00 2001 From: Esther Christopher Date: Thu, 13 Oct 2022 13:04:42 +0100 Subject: [PATCH 1/2] Reviewed the documentation 1. Edited the topic of the documentation to Pascal Case. 2. Completed a sentence for clarity --- docs/source/events/index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/events/index.rst b/docs/source/events/index.rst index bc086ba1..b6303263 100644 --- a/docs/source/events/index.rst +++ b/docs/source/events/index.rst @@ -1,4 +1,4 @@ -Eventlogging and Telemetry +Event Logging and Telemetry ========================== JupyterHub can be configured to record structured events from a running server using Jupyter's `Telemetry System`_. The types of events that JupyterHub emits are defined by `JSON schemas`_ listed at the bottom of this page_. @@ -15,7 +15,7 @@ Event logging is handled by its ``Eventlog`` object. This leverages Python's sta To begin recording events, you'll need to set two configurations: - 1. ``handlers``: tells the EventLog *where* to route your events. This trait is a list of Python logging handlers that route events to + 1. ``handlers``: tells the EventLog *where* to route your events. This trait is a list of Python logging handlers that route events to the event log file. 2. ``allows_schemas``: tells the EventLog *which* events should be recorded. No events are emitted by default; all recorded events must be listed here. Here's a basic example: From f0957ad247b1ca925522ec932a00f45ae8b522a2 Mon Sep 17 00:00:00 2001 From: Esther Christopher Date: Sat, 22 Oct 2022 00:07:12 +0100 Subject: [PATCH 2/2] Resolve conflicts in event doc --- docs/source/events/index.rst | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/docs/source/events/index.rst b/docs/source/events/index.rst index 232e01ad..bbbf680f 100644 --- a/docs/source/events/index.rst +++ b/docs/source/events/index.rst @@ -1,6 +1,5 @@ -patch-1 -Event Logging and Telemetry -main +Event logging and telemetry +=========================== JupyterHub can be configured to record structured events from a running server using Jupyter's `Telemetry System`_. The types of events that JupyterHub emits are defined by `JSON schemas`_ listed at the bottom of this page_. @@ -16,10 +15,8 @@ Event logging is handled by its ``Eventlog`` object. This leverages Python's sta To begin recording events, you'll need to set two configurations: -patch-1 1. ``handlers``: tells the EventLog *where* to route your events. This trait is a list of Python logging handlers that route events to the event log file. 2. ``allows_schemas``: tells the EventLog *which* events should be recorded. No events are emitted by default; all recorded events must be listed here. - main Here's a basic example: