List of available metrics
The following system metrics are available, grouped according to service:
| Metric Name | Description | Dimensions |
|---|---|---|
| Passport Service | ||
dtplatform.passportsvc.WorkspaceCount | Number of workspaces per namespace | namespace: application namespace |
dtplatform.passportsvc.UserGroupCount | Number of user groups per namespace | namespace: application namespace |
dtplatform.passportsvc.UserCount | Number of users in the system | None |
dtplatform.passportsvc.ApplicationCount | Number of applications in the system | None |
| Item Service | ||
dtplatform.itemsvc.NamedUserCollectionCount | Number of named user collections | namespace: typically a workspace namespace |
dtplatform.itemsvc.NamedUserCollectionVersionCount | Number of named user collection versions | namespace: typically a workspace namespace collection: collection user item ID |
dtplatform.itemsvc.NamedUserCollectionVersionSize | Size on disk of named user collection version | namespace: typically a workspace namespace collection collection user item ID version: (version number of the named user collection) |
dtplatform.itemsvc.NamedUserCollectionRelatedItemsCount | Number of related items per named user collection version | namespace: typically a workspace namespace collection: collection user item ID version: version number of the named user collection |
dtplatform.itemsvc.NamedFileCollectionCount | Number of named file collections | namespace: typically a workspace namespace |
dtplatform.itemsvc.NamedFileCollectionVersionCount | Number of named file collection versions | namespace: typically a workspace namespace collection: collection user item ID |
dtplatform.itemsvc.NamedFileCollectionVersionSize | Size on disk of named file collection version | namespace: typically a workspace namespace collection: collection user item ID version: version number of the named user collection |
dtplatform.itemsvc.NamedFileCollectionRelatedItemsCount | Number of related items per named file collection version | namespace: typically a workspace namespace collection: collection user item ID version: version number of the named user collection |
dtplatform.itemsvc.NamedTelemetryCollectionCount | Number of named telemetry collections | namespace: typically a workspace namespace |
dtplatform.itemsvc.NamedTelemetryCollectionVersionCount | Number of named telemetry collection versions | namespace: typically a workspace namespace collection: collection user item ID |
dtplatform.itemsvc.NamedTelemetryCollectionVersionSize | Size on disk of named telemetry collection version | namespace: typically a workspace namespace collection: collection user item ID version: version number of the named user collection |
dtplatform.itemsvc.NamedTelemetryCollectionRelatedItemsCount | Number of related items per named telemetry collection version | namespace: typically a workspace namespace collection: collection user item ID version: version number of the named user collection |
dtplatform.itemsvc.NamedTelemetryCollectionTimeSeriesCollectionSize | Size on disk of time series collection of named telemetry collection version | namespace: typically a workspace namespace collection: collection user item ID version: version number of the named user collection |
dtplatform.itemsvc.ScriptCount | Number of scripts | namespace: typically a workspace namespace |
dtplatform.itemsvc.ScriptVersionCount | Number of script versions | namespace: typically a workspace namespace item: script ID |
dtplatform.itemsvc.ScriptVersionSize | Size on disk of script version | namespace: typically a workspace namespace item: script ID version: version number of the script |
dtplatform.itemsvc.UserConfigCount | Number of user configurations | namespace: typically a workspace namespace |
dtplatform.itemsvc.UserConfigVersionCount | Number of versions of user configurations | namespace: typically a workspace namespace item: user config ID |
dtplatform.itemsvc.UserConfigVersionSize | Size on disk of user configuration version | namespace: typically a workspace namespace item: user config ID version: version number of the script |
dtplatform.itemsvc.NamedCompositeItemCount | Number of named composite items | namespace: typically a workspace namespace |
dtplatform.itemsvc.NamedCompositeItemVersionCount | Number of versions per named composite item | namespace: typically a workspace namespace item: named composite item ID |
dtplatform.itemsvc.NamedCompositeItemSize | Size on disk of MongoDB collection of named composite item | namespace: typically a workspace namespace item: named composite item ID |
dtplatform.itemsvc.NamedCompositeItemVersionSize | Size on disk of named composite item version | namespace: typically a workspace namespace item: named composite item ID version: version number of named composite item |
dtplatform.itemsvc.NamedCompositeItemRelatedCollectionCount | Number of related collections per named composite item | namespace: typically a workspace namespace item: named composite item ID |
| File Service | ||
dtplatform.filesvc.FileCount | Number of files (excluding graphics files) | namespace: typically a workspace namespace |
dtplatform.filesvc.FileVersionCount | Number of file versions (excluding graphics files) | namespace: typically a workspace namespace file_id: file ID |
dtplatform.filesvc.FileVersionSize | Size on disk of file version (excluding graphics files) | namespace: typically a workspace namespace file_id: file ID version: version number of the file |
dtplatform.filesvc.PreviewImageFileSize | Size on disk of image preview file version | namespace: typically a workspace namespace file_id: file ID version: version number of the file |
dtplatform.filesvc.FileCount.graphics | Number of graphics files | namespace: typically a workspace namespace |
dtplatform.filesvc.FileVersionCount.graphics | Number of graphic file versions | namespace: typically a workspace namespace file_id: file ID |
dtplatform.filesvc.FileVersionSize.graphics | Size on disk of graphics file version | namespace: typically a workspace namespace file_id: file ID version: version number of the file |
How to use the Metrics Service#
Using the REST API#
Use the Metrics Service by making API calls to the relevant endpoints. For more information on using the REST API, refer to the Metrics Service API overview page.