Skip to content

Commit dfc19c8

Browse files
authored
Merge pull request #57 from TharmiganK/observability-doc
Add Observability Overview docoument
2 parents 27ec157 + 7ec8234 commit dfc19c8

File tree

6 files changed

+38
-1
lines changed

6 files changed

+38
-1
lines changed
Loading
Loading
Loading
+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Observability Overview
2+
3+
The Devant observability dashboard provides a comprehensive interface to visualize and monitor the performance of services deployed on Devant.
4+
5+
![Dashboard overview](../assets/img/monitoring-and-insights/observability/overview-overall.png){.cInlineImage-full}
6+
7+
The Observability dashboard allows you to:
8+
9+
- View runtime logs generated over a specific timeframe.
10+
- Observe the throughput and latencies of requests served over a given period.
11+
- Observe the CPU and memory usage over a given period.
12+
- Compare metrics side-by-side to facilitate efficient diagnosis.
13+
14+
## Logs
15+
16+
The **Logs** pane serves as a centralized view to observe logs of the integrations you deploy on Devant. This facilitates rigorous troubleshooting and analysis.
17+
18+
![Runtime logs](../assets/img/monitoring-and-insights/observability/runtime-logs.png){.cInlineImage-full}
19+
20+
## Metrics
21+
22+
The **Metrics** pane provides a graphical representation of the following metrics:
23+
24+
- Request per minute
25+
- Latency
26+
- Memory usage
27+
- CPU usage
28+
- Data transfer
29+
- Disk usage
30+
31+
![Metrics graph](../assets/img/monitoring-and-insights/observability/metrics.png){.cInlineImage-full}
32+
33+
By default, Devant renders this graph for the data generated within the past 24 hours. You can change the default time window by selecting the time range and zone from the options bar. To expand the graph, click and drag the cursor over the period you want to drill down.
34+
35+
You can view the Devant service logs in the **Runtime Logs** pane below the metrics. Clicking on a graph updates the **Runtime Logs** view to contain the corresponding log entries generated at that time. You can use these logs to identify the reasons for any anomalies you detect using the graph.

Diff for: en/docs/sharing-and-reusing/use-a-connection-in-your-integration.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Devant allows you to share and reuse your services, accelerating development and
44

55
For step-by-step on instruction on creating a connection, see [Create a Connection](create-a-connection.md).
66

7-
To learn more about Devant Connections, see the documentation on [Connections](../../Devant-concepts/connections.md).
7+
To learn more about Devant Connections, see the documentation on [Connections](../devant-concepts/connections.md).
88

99
## Consume a service through a connection
1010

Diff for: en/mkdocs.yml

+2
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,8 @@ nav:
106106
- Add Devant-Managed Databases and Caches to the Marketplace: manage-databases-and-caches/add-devant-managed-databases-and-caches-to-the-marketplace.md
107107
- Testing:
108108
- Test REST Endpoints via the OpenAPI Console: testing/test-rest-endpoints-via-the-openapi-console.md
109+
- Monitoring and Insights:
110+
- Observability Overview: monitoring-and-insights/observability-overview.md
109111
# Extensions
110112
markdown_extensions:
111113
- markdown.extensions.admonition

0 commit comments

Comments
 (0)