Overview
There are several performance counter values exposed via the v1/diagnostics/metrics ReST endpoint. These values can help with diagnosing server health. See the table below for a list of the performance counters available.
Metric | Description |
|---|---|
| app.memory.usage | Amount of memory DataHub is currently using in MB |
| app.uptime | The amount of time DataHub has been running in seconds |
| app.version.build | DataHub application build (e.g. 4.0.0.1601-beta-f8f1fab594323c5111a7882eb20c748ef8cabf79) |
| app.version.product | DataHub application version (e.g. 4.0.0.1601) |
| app.cpu.usage | Total current DataHub CPU usage in percent |
| app.disk.reads_per_sec | Number of disk reads per second for DataHub |
| app.disk.writes_per_sec | Number of disk writes per second for DataHub |
| {platform name}.{connection id}.http.requests | Number of http request made to connection (Histogram) |
| {platform name}.{connection id}.ratelimit.occurrences | Number of rate limits that have occurred on connection |
| {platform name}.{connection id}.ratelimit.pending | Number of threads currently waiting on rate limits |
| {platform name}.{connection id}.ratelimit.rate | Number of rate limits occurring per time unit |
| {platform name}.{connection id}.ratelimit.wait | Amount of time spent waiting for rate limits (Timer) |
| system.cpu.arch | System CPU architecture (e.g. x64) |
| system.cpu.count | Total number of CPUs for the system |
| system.cpu.usage | Total current system CPU usage in percent |
| system.os.arch | System architecture (e.g. x64) |
| system.os.description | Operating System (e.g. Microsoft Windows 10.0.15.063) |
| system.platform | Platform of the system (e.g. windows, linux) |
| system.runtime.description | The system's runtime (e.g. .NET Core 4.6) |
| system.timezone | Timezone of the system |
| system.username | The system account that DataHub is running under |
| system.disk.reads_per_sec | Number of disk reads per second for the entire system |
| system.disk.writes_per_sec | Number of disk writes per second for the entire system |
| system.machine | Machine name |
| system.domain | Windows domain name of the running DataHub service |
| system.memory.available | Available system memory in MB |
| threadpool.io.available | dotnet io threads available |
| threadpool.io.max | dotnet io maximum threads |
| threadpool.io.min | dotnet io minimum threads |
| threadpool.threads.available | dotnet total threads available |
| threadpool.threads.max | dotnet total maximum threads |
| threadpool.threads.min | dotnet total minimum threads |
Usage
These metrics are retrieved via a ReST request: GET <server-url>/v1/diagnostics/metrics. The request must include an appropriate Authorization header with a valid access token. An example response is found below.
GET <server-url>/v1/diagnostics/metrics
|
GET {{url}}v1/diagnostics/system
|
|
Monitoring using Prometheus
|