diff --git a/src/guide/monitoring.md b/src/guide/monitoring.md new file mode 100644 index 0000000..8c5f043 --- /dev/null +++ b/src/guide/monitoring.md @@ -0,0 +1,54 @@ +# Monitoring + +When modules are used in [endpoints](https://docs.nodescript.dev/guide/endpoints) and schedules, they run automatically. By default, you won't be able to see the results of that running instance as you would if you had run the graph manually. + +Instead, you can view the results of all the running instances of your modules on the Monitoring page: + +![](../images/monitoring-1.png) + +**Log Indicators** + +Each log entry displays an icon to indicate its type on the left-hand side: + +* Schedule: + +* Endpoint: + +On the right hand side, for each instance you are able to see: + +* Status, e.g. `200` +* Amount of times it has run, e.g. `3x` +* Latency, e.g. `234ms` + +

+The log samples have a granularity of minutes, which you'll be able to see for 10 days. + +After this time, you'll still be able to access back the logs using the arrows, but the logs will have an hourly granularity. +

+ + +**Filtering** + +You are able to filter the logs in the Monitoring page. + +To filter by type, in one of the logs, click on its icon: either a schedule: + + or endpoint: + + + And to filter by status, e.g. `404` or `200` simply click in the status. + +You should see something similar to the below: + + +![](../images/monitoring-filters.png) + +This can aid you in finding particular errors or warnings that may have occurred for a particular type of log instance. + + +**Identifying Errors** + +By clicking on each log, you can expand it to see the error messages more clearly: + +![](../images/monitoring-error.png) + diff --git a/src/images/monitoring-1.png b/src/images/monitoring-1.png new file mode 100644 index 0000000..2d4543c Binary files /dev/null and b/src/images/monitoring-1.png differ diff --git a/src/images/monitoring-error.png b/src/images/monitoring-error.png new file mode 100644 index 0000000..a36dd6f Binary files /dev/null and b/src/images/monitoring-error.png differ diff --git a/src/images/monitoring-filters.png b/src/images/monitoring-filters.png new file mode 100644 index 0000000..1cb0aee Binary files /dev/null and b/src/images/monitoring-filters.png differ