Overview
The v1/diagnostics/metrics REST endpoint exposes several performance counter values, which can help diagnose server health. The table below lists the available performance counters.
| Metric | Description |
|---|---|
| app.memory.usage | Amount of memory DryvIQ is currently using in MB |
| app.uptime | The amount of time DryvIQ has been running in seconds |
| app.version.build | DryvIQ Platform build (e.g. 4.0.0.1601-beta-f8f1fab594323c5111a7882eb20c748ef8cabf79) |
| app.version.product | DryvIQ Platform version (e.g. 4.0.0.1601) |
| app.cpu.usage | Total current DryvIQ CPU usage in percent |
| app.disk.reads_per_sec | Number of disk reads per second for DryvIQ |
| app.disk.writes_per_sec | Number of disk writes per second for DryvIQ |
| http.{platform name}.{connection id}.requests | Number of http request made to connection (Histogram) |
| ratelimiter.{platform name}.{connection id}.occurrences | Number of rate limits that have occurred on connection |
| ratelimiter.{platform name}.{connection id}.pending | Number of threads currently waiting on rate limits |
| ratelimiter.{platform name}.{connection id}.rate | Number of rate limits occurring per time unit |
| ratelimiter.{platform name}.{connection id}.wait | Amount of time spent waiting for rate limits (Timer) |
| schedulers.{id}.{node_address}.executing | Number of scheduled jobs currently executing |
| schedulers.{id}.{node_address}.max | Concurrent job limit that determines how many scheduled jobs can run concurrently |
| schedulers.{id}.{node_address}.pending | Number of scheduled jobs currently waiting to run |
| system.cpu.arch | System CPU architecture (e.g. x64) |
| system.cpu.count | Total number of CPUs for the system |
| system.domain | Windows domain name of the running DryvIQ service |
| system.machine | Machine name |
| 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 | Time zone of the system |
| system.username | The system account that DryvIQ is running under |
| 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 |
GET Metrics
These metrics are retrieved via a REST request: GET {{url}}/v1/diagnostics/metrics. The request must include an appropriate Authorization header with a valid access token. An example response is found below.
{
"status": 200,
"type": "metrics",
"metrics": {
"app.memory.usage": {
"value": 341.7578125,
"type": "gauge",
"group": "app",
"name": "memory.usage"
},
"app.uptime": {
"value": 22607.7910918,
"type": "gauge",
"group": "app",
"name": "uptime"
},
"app.version.build": {
"value": "4.23.0-beta-3015 Commit Hash: e15038c2834a4cf9695cc2fb99ab4fc4a259b590",
"type": "gauge",
"group": "app",
"name": "version.build"
},
"app.version.product": {
"value": "4.23.0.3015",
"type": "gauge",
"group": "app",
"name": "version.product"
},
"http.box.0d8f539693374305be9ab95c635c36fd.requests": {
"meter": {
"count": 4,
"rate": 0.0002261931773169876,
"m1_rate": 7.155450781929187E-129,
"m5_rate": 1.560968721852013E-26,
"m15_rate": 1.7778532686409235E-09,
"type": "meter"
},
"histogram": {
"count": 4,
"snapshot": {
"count": 4,
"min": 188864766,
"max": 2960222681,
"mean": 1340110612.923259,
"median": 1431729376.0,
"p75": 2960222681.0,
"p95": 2960222681.0,
"p98": 2960222681.0,
"p99": 2960222681.0,
"p999": 2960222681.0,
"stdev": 1048575402.9176669
},
"type": "histogram"
},
"type": "timer",
"group": "http",
"name": "requests",
"labels": {
"id": "0d8f539693374305be9ab95c635c36fd",
"platform": "box"
}
},
"http.box.31dce19df6514760a43bf2329673c327.requests": {
"meter": {
"count": 4,
"rate": 0.00022618368397470326,
"m1_rate": 5.038892240421217E-129,
"m5_rate": 1.0522404848645747E-26,
"m15_rate": 1.189629330633642E-09,
"type": "meter"
},
"histogram": {
"count": 4,
"snapshot": {
"count": 4,
"min": 98666576,
"max": 3037092318,
"mean": 1325296217.380008,
"median": 1411992903.0,
"p75": 3037092318.0,
"p95": 3037092318.0,
"p98": 3037092318.0,
"p99": 3037092318.0,
"p999": 3037092318.0,
"stdev": 1107188836.9481962
},
"type": "histogram"
},
"type": "timer",
"group": "http",
"name": "requests",
"labels": {
"id": "31dce19df6514760a43bf2329673c327",
"platform": "box"
}
},
"http.box.73cf98a507304446b47b4d8515af21ec.requests": {
"meter": {
"count": 2,
"rate": 9.216240996806524E-05,
"m1_rate": 3.701805330638276E-158,
"m5_rate": 1.5679445805532E-32,
"m15_rate": 1.3587833931201888E-11,
"type": "meter"
},
"histogram": {
"count": 2,
"snapshot": {
"count": 2,
"min": 252760530,
"max": 760111831,
"mean": 506436180.5,
"median": 760111831.0,
"p75": 760111831.0,
"p95": 760111831.0,
"p98": 760111831.0,
"p99": 760111831.0,
"p999": 760111831.0,
"stdev": 253675650.5
},
"type": "histogram"
},
"type": "timer",
"group": "http",
"name": "requests",
"labels": {
"id": "73cf98a507304446b47b4d8515af21ec",
"platform": "box"
}
},
"http.office365-graph.565b0e3f8a5341dab86af27afb8d71f4.requests": {
"meter": {
"count": 1407,
"rate": 0.07958454427552508,
"m1_rate": 7.611655681978393E-127,
"m5_rate": 5.126473789391864E-25,
"m15_rate": 4.743667019816161E-08,
"type": "meter"
},
"histogram": {
"count": 1407,
"snapshot": {
"count": 1028,
"min": 42412344,
"max": 295113402,
"mean": 54740291.49171737,
"median": 48574019.0,
"p75": 51282273.0,
"p95": 90846801.0,
"p98": 162043519.0,
"p99": 179789109.0,
"p999": 295113402.0,
"stdev": 26077410.590947274
},
"type": "histogram"
},
"type": "timer",
"group": "http",
"name": "requests",
"labels": {
"id": "565b0e3f8a5341dab86af27afb8d71f4",
"platform": "office365-graph"
}
},
"http.onedrive-business-graph.871c53ec43e1476e9277d32185d16726.requests": {
"meter": {
"count": 4193,
"rate": 0.23717026383441236,
"m1_rate": 4.17527500640614E-126,
"m5_rate": 1.0651760929634054E-24,
"m15_rate": 8.249032712981478E-08,
"type": "meter"
},
"histogram": {
"count": 4193,
"snapshot": {
"count": 1028,
"min": 42451095,
"max": 223869819,
"mean": 51758007.98007122,
"median": 46864260.0,
"p75": 49095748.0,
"p95": 82974117.0,
"p98": 130100720.0,
"p99": 150708439.0,
"p999": 186129383.0,
"stdev": 18950665.5855292
},
"type": "histogram"
},
"type": "timer",
"group": "http",
"name": "requests",
"labels": {
"id": "871c53ec43e1476e9277d32185d16726",
"platform": "onedrive-business-graph"
}
},
"ratelimiter.box.0d8f539693374305be9ab95c635c36fd.occurrences": {
"count": 0,
"type": "meter",
"group": "ratelimiter",
"name": "occurrences",
"labels": {
"id": "0d8f539693374305be9ab95c635c36fd",
"platform": "box"
}
},
"ratelimiter.box.0d8f539693374305be9ab95c635c36fd.pending": {
"type": "count",
"group": "ratelimiter",
"name": "pending",
"labels": {
"id": "0d8f539693374305be9ab95c635c36fd",
"platform": "box"
}
},
"ratelimiter.box.0d8f539693374305be9ab95c635c36fd.rate": {
"value": 60.0,
"type": "gauge",
"group": "ratelimiter",
"name": "rate",
"labels": {
"id": "0d8f539693374305be9ab95c635c36fd",
"platform": "box"
}
},
"ratelimiter.box.0d8f539693374305be9ab95c635c36fd.wait": {
"meter": {
"count": 3,
"rate": 0.00016964488383300086,
"m1_rate": 6.954006992577888E-129,
"m5_rate": 1.5522727191295948E-26,
"m15_rate": 1.7745579049861489E-09,
"type": "meter"
},
"histogram": {
"count": 3,
"snapshot": {
"count": 3,
"min": 5920,
"max": 10300,
"mean": 8607.038815158998,
"median": 9750.0,
"p75": 10300.0,
"p95": 10300.0,
"p98": 10300.0,
"p99": 10300.0,
"p999": 10300.0,
"stdev": 1963.1860116383957
},
"type": "histogram"
},
"type": "timer",
"group": "ratelimiter",
"name": "wait",
"labels": {
"id": "0d8f539693374305be9ab95c635c36fd",
"platform": "box"
}
},
"ratelimiter.box.31dce19df6514760a43bf2329673c327.occurrences": {
"count": 0,
"type": "meter",
"group": "ratelimiter",
"name": "occurrences",
"labels": {
"id": "31dce19df6514760a43bf2329673c327",
"platform": "box"
}
},
"ratelimiter.box.31dce19df6514760a43bf2329673c327.pending": {
"type": "count",
"group": "ratelimiter",
"name": "pending",
"labels": {
"id": "31dce19df6514760a43bf2329673c327",
"platform": "box"
}
},
"ratelimiter.box.31dce19df6514760a43bf2329673c327.rate": {
"value": 60.0,
"type": "gauge",
"group": "ratelimiter",
"name": "rate",
"labels": {
"id": "31dce19df6514760a43bf2329673c327",
"platform": "box"
}
},
"ratelimiter.box.31dce19df6514760a43bf2329673c327.wait": {
"meter": {
"count": 3,
"rate": 0.0001696377615798576,
"m1_rate": 4.837448451069879E-129,
"m5_rate": 1.0435444821421564E-26,
"m15_rate": 1.1863339669788703E-09,
"type": "meter"
},
"histogram": {
"count": 3,
"snapshot": {
"count": 3,
"min": 6490,
"max": 27990,
"mean": 14166.042832506178,
"median": 8780.0,
"p75": 27990.0,
"p95": 27990.0,
"p98": 27990.0,
"p99": 27990.0,
"p999": 27990.0,
"stdev": 9567.11734024347
},
"type": "histogram"
},
"type": "timer",
"group": "ratelimiter",
"name": "wait",
"labels": {
"id": "31dce19df6514760a43bf2329673c327",
"platform": "box"
}
},
"ratelimiter.box.73cf98a507304446b47b4d8515af21ec.occurrences": {
"count": 0,
"type": "meter",
"group": "ratelimiter",
"name": "occurrences",
"labels": {
"id": "73cf98a507304446b47b4d8515af21ec",
"platform": "box"
}
},
"ratelimiter.box.73cf98a507304446b47b4d8515af21ec.pending": {
"type": "count",
"group": "ratelimiter",
"name": "pending",
"labels": {
"id": "73cf98a507304446b47b4d8515af21ec",
"platform": "box"
}
},
"ratelimiter.box.73cf98a507304446b47b4d8515af21ec.rate": {
"value": 60.0,
"type": "gauge",
"group": "ratelimiter",
"name": "rate",
"labels": {
"id": "73cf98a507304446b47b4d8515af21ec",
"platform": "box"
}
},
"ratelimiter.box.73cf98a507304446b47b4d8515af21ec.wait": {
"meter": {
"count": 1,
"rate": 4.60811468251079E-05,
"m1_rate": 1.850902665319138E-158,
"m5_rate": 7.839722902766E-33,
"m15_rate": 6.793916965600944E-12,
"type": "meter"
},
"histogram": {
"count": 1,
"snapshot": {
"count": 1,
"min": 1284957,
"max": 1284957,
"mean": 1284957.0,
"median": 1284957.0,
"p75": 1284957.0,
"p95": 1284957.0,
"p98": 1284957.0,
"p99": 1284957.0,
"p999": 1284957.0
},
"type": "histogram"
},
"type": "timer",
"group": "ratelimiter",
"name": "wait",
"labels": {
"id": "73cf98a507304446b47b4d8515af21ec",
"platform": "box"
}
},
"ratelimiter.office365-graph.565b0e3f8a5341dab86af27afb8d71f4-https://desktop-sharepoint-com.occurrences": {
"count": 0,
"type": "meter",
"group": "ratelimiter",
"name": "occurrences",
"labels": {
"id": "565b0e3f8a5341dab86af27afb8d71f4-https://desktop-sharepoint-com",
"platform": "office365-graph"
}
},
"ratelimiter.office365-graph.565b0e3f8a5341dab86af27afb8d71f4-https://desktop-sharepoint-com.pending": {
"type": "count",
"group": "ratelimiter",
"name": "pending",
"labels": {
"id": "565b0e3f8a5341dab86af27afb8d71f4-https://desktop-sharepoint-com",
"platform": "office365-graph"
}
},
"ratelimiter.office365-graph.565b0e3f8a5341dab86af27afb8d71f4-https://desktop-sharepoint-com.rate": {
"value": 60.0,
"type": "gauge",
"group": "ratelimiter",
"name": "rate",
"labels": {
"id": "565b0e3f8a5341dab86af27afb8d71f4-https://desktop-sharepoint-com",
"platform": "office365-graph"
}
},
"ratelimiter.office365-graph.565b0e3f8a5341dab86af27afb8d71f4-https://desktop-sharepoint-com.wait": {
"meter": {
"count": 1409,
"rate": 0.07968112680353248,
"m1_rate": 6.110253044102059E-127,
"m5_rate": 2.1087288464801888E-25,
"m15_rate": 1.3081806054922889E-08,
"type": "meter"
},
"histogram": {
"count": 1409,
"snapshot": {
"count": 1028,
"min": 2631,
"max": 429175,
"mean": 6760.71800136958,
"median": 5900.0,
"p75": 6810.0,
"p95": 8290.0,
"p98": 9350.0,
"p99": 12900.0,
"p999": 429175.0,
"stdev": 17260.92119272214
},
"type": "histogram"
},
"type": "timer",
"group": "ratelimiter",
"name": "wait",
"labels": {
"id": "565b0e3f8a5341dab86af27afb8d71f4-https://desktop-sharepoint-com",
"platform": "office365-graph"
}
},
"ratelimiter.onedrive-business-graph.871c53ec43e1476e9277d32185d16726-https://desktop-my-sharepoint-com/personal/admin_desktop_onmicrosoft_com.occurrences": {
"count": 0,
"type": "meter",
"group": "ratelimiter",
"name": "occurrences",
"labels": {
"id": "871c53ec43e1476e9277d32185d16726-https://desktop-my-sharepoint-com/personal/admin_desktop_onmicrosoft_com",
"platform": "onedrive-business-graph"
}
},
"ratelimiter.onedrive-business-graph.871c53ec43e1476e9277d32185d16726-https://desktop-my-sharepoint-com/personal/admin_desktop_onmicrosoft_com.pending": {
"type": "count",
"group": "ratelimiter",
"name": "pending",
"labels": {
"id": "871c53ec43e1476e9277d32185d16726-https://desktop-my-sharepoint-com/personal/admin_desktop_onmicrosoft_com",
"platform": "onedrive-business-graph"
}
},
"ratelimiter.onedrive-business-graph.871c53ec43e1476e9277d32185d16726-https://desktop-my-sharepoint-com/personal/admin_desktop_onmicrosoft_com.rate": {
"value": 60.0,
"type": "gauge",
"group": "ratelimiter",
"name": "rate",
"labels": {
"id": "871c53ec43e1476e9277d32185d16726-https://desktop-my-sharepoint-com/personal/admin_desktop_onmicrosoft_com",
"platform": "onedrive-business-graph"
}
},
"ratelimiter.onedrive-business-graph.871c53ec43e1476e9277d32185d16726-https://desktop-my-sharepoint-com/personal/admin_desktop_onmicrosoft_com.wait": {
"meter": {
"count": 4195,
"rate": 0.23723276373300145,
"m1_rate": 3.866016947155264E-126,
"m5_rate": 5.700900497910982E-25,
"m15_rate": 2.6218335207826725E-08,
"type": "meter"
},
"histogram": {
"count": 4195,
"snapshot": {
"count": 1028,
"min": 2900,
"max": 151291,
"mean": 6160.057602608696,
"median": 5560.0,
"p75": 6260.0,
"p95": 8080.0,
"p98": 8690.0,
"p99": 9631.0,
"p999": 151291.0,
"stdev": 6857.721623021746
},
"type": "histogram"
},
"type": "timer",
"group": "ratelimiter",
"name": "wait",
"labels": {
"id": "871c53ec43e1476e9277d32185d16726-https://desktop-my-sharepoint-com/personal/admin_desktop_onmicrosoft_com",
"platform": "onedrive-business-graph"
}
},
"schedulers.default.172-18-0-2.executing": {
"value": 0,
"type": "gauge",
"group": "schedulers",
"name": "executing",
"labels": {
"id": "default",
"node_address": "172-18-0-2"
}
},
"schedulers.default.172-18-0-2.max": {
"value": 6,
"type": "gauge",
"group": "schedulers",
"name": "max",
"labels": {
"id": "default",
"node_address": "172-18-0-2"
}
},
"schedulers.default.172-18-0-2.pending": {
"value": 0,
"type": "gauge",
"group": "schedulers",
"name": "pending",
"labels": {
"id": "default",
"node_address": "172-18-0-2"
}
},
"schedulers.local-172-18-0-2.172-18-0-2.executing": {
"value": 0,
"type": "gauge",
"group": "schedulers",
"name": "executing",
"labels": {
"id": "local-172-18-0-2",
"node_address": "172-18-0-2"
}
},
"schedulers.local-172-18-0-2.172-18-0-2.max": {
"value": 6,
"type": "gauge",
"group": "schedulers",
"name": "max",
"labels": {
"id": "local-172-18-0-2",
"node_address": "172-18-0-2"
}
},
"schedulers.local-172-18-0-2.172-18-0-2.pending": {
"value": 0,
"type": "gauge",
"group": "schedulers",
"name": "pending",
"labels": {
"id": "local-172-18-0-2",
"node_address": "172-18-0-2"
}
},
"schedulers.system.172-18-0-2.executing": {
"value": 0,
"type": "gauge",
"group": "schedulers",
"name": "executing",
"labels": {
"id": "system",
"node_address": "172-18-0-2"
}
},
"schedulers.system.172-18-0-2.max": {
"value": 6,
"type": "gauge",
"group": "schedulers",
"name": "max",
"labels": {
"id": "system",
"node_address": "172-18-0-2"
}
},
"schedulers.system.172-18-0-2.pending": {
"value": 0,
"type": "gauge",
"group": "schedulers",
"name": "pending",
"labels": {
"id": "system",
"node_address": "172-18-0-2"
}
},
"system.cpu.arch": {
"value": "x64",
"type": "gauge",
"group": "system",
"name": "cpu.arch"
},
"system.cpu.count": {
"value": 8,
"type": "gauge",
"group": "system",
"name": "cpu.count"
},
"system.domain": {
"value": "f050f6cdc2a5",
"type": "gauge",
"group": "system",
"name": "domain"
},
"system.machine": {
"value": "f050f6cdc2a5",
"type": "gauge",
"group": "system",
"name": "machine"
},
"system.os.arch": {
"value": "x64",
"type": "gauge",
"group": "system",
"name": "os.arch"
},
"system.os.description": {
"value": "Linux 5.11.0-1019-aws #20~20.04.1-Ubuntu SMP Tue Sep 21 10:40:39 UTC 2021",
"type": "gauge",
"group": "system",
"name": "os.description"
},
"system.platform": {
"value": "linux",
"type": "gauge",
"group": "system",
"name": "platform"
},
"system.runtime.description": {
"value": ".NET 5.0.9",
"type": "gauge",
"group": "system",
"name": "runtime.description"
},
"system.timezone": {
"value": "(UTC+00:00) Coordinated Universal Time",
"type": "gauge",
"group": "system",
"name": "timezone"
},
"system.username": {
"value": "root",
"type": "gauge",
"group": "system",
"name": "username"
},
"threadpool.io.available": {
"value": 1000,
"type": "gauge",
"group": "threadpool",
"name": "io.available",
"description": "Displays real time available IO thread count"
},
"threadpool.io.max": {
"value": 1000,
"type": "gauge",
"group": "threadpool",
"name": "io.max",
"description": "Displays real time maximum IO thread count"
},
"threadpool.io.min": {
"value": 8,
"type": "gauge",
"group": "threadpool",
"name": "io.min",
"description": "Displays real time minimum IO thread count"
},
"threadpool.threads.available": {
"value": 32763,
"type": "gauge",
"group": "threadpool",
"name": "threads.available",
"description": "Displays real time available processing thread count"
},
"threadpool.threads.max": {
"value": 32767,
"type": "gauge",
"group": "threadpool",
"name": "threads.max",
"description": "Displays real time maximum processing thread count"
},
"threadpool.threads.min": {
"value": 8,
"type": "gauge",
"group": "threadpool",
"name": "threads.min",
"description": "Displays real time minimum processing thread count"
}
}
}GET System Information
Below is an example of the response for GET {{url}}v1/diagnostics/system.
{
"status": 200,
"item": {
"app_product_version": "4.6.5.0",
"app_build_version": "4.6.5 Commit Hash: 897208b845f02ad2a17bb04581f95d950c84e5c8",
"system_platform": "linux",
"system_time_zone": "UTC",
"system_runtime_description": ".NET Core 4.6.26725.06",
"system_os_architecture": "x64",
"system_os_description": "Linux 4.14.62-70.117.amzn2.x86_64 #1 SMP Fri Aug 10 20:14:53 UTC 2018",
"system_os_version": "4.14.62.70",
"system_cpu_count": 2,
"system_cpu_architecture": "x64",
"process_memory_size": 529461248,
"process_dot_net_gen_size": 237947768,
"bytes_under_management": 36983021614,
"bytes_under_management_by_job": [
{
"job_id": 6,
"bytes": 367364
},
{
"job_id": 7,
"bytes": 4610
},
........
...........
.............
"jobs_count": 80,
"jobs": [
{
"source_platform": "box",
"destination_platform": "box",
"transfer_type": "copy",
"count": 3
},
{
"source_platform": "box",
"destination_platform": "dfb",
"transfer_type": "copy",
"count": 1
},
.........
............
...............
"nodes_count": 1,
"connections_count": 11,
"connections": [
{
"platform": "box",
"count": 2
},
{
"platform": "dfb",
"count": 3
},
.........
............
...............
"license_key": "bbbbbbb-0000-0000-0000-cc9a375813ea",
"license_uuid_activation": "BBBD5A0FFFFA4B10A2FCBAB0CCCCCCC"
}
}Monitoring Using Prometheus
{{url}}v1/diagnostics/metrics/prometheus