Passport Service Metrics

Metrics available

For the Passport Service, the following Metrics Service APIs are available:

• WorkspaceCount
• UserGroupCount
• UserCount
• ApplicationCount

WorkspaceCount

This API call returns the number of workspaces per namespace. The namespace in this context is an application namespace.

Endpoints

Two forms of endpoints are available:

GET /metricsvc/api/v1/metrics/dtplatform.passportsvc.WorkspaceCount?{dimensions}

GET /metricsvc/api/v1/metrics/dtplatform.passportsvc.WorkspaceCount/by-dimension;{dimensions}?{period parameters}

Request

Query parameters

Parameter	Type	Description	Required
namespace	String	Filter by application namespace.	Required

Body

Example:

This example shows a request to return the WorkspaceCount for the namespace called digitaltwin_883WeSED

GET /metricsvc/api/v1/metrics/dtplatform.passportsvc.WorkspaceCount?namespace=digitaltwin_883WeSED

Response

This example response shows that number of workspaces in the digitaltwin_883WeSED application namespace was counted as 1218 at 14:00 on 25th July, and 1217 at 04:00 on 26th July.

{
    "metricName": "dtplatform.passportsvc.WorkspaceCount",
    "dimensions": {
        "namespace": "digitaltwin_883WeSED"
    },
    "metrics": [
        {
            "timestamp": "2024-07-25T14:00:00Z",
            "value": 1218
        },
        {
            "timestamp": "2024-07-26T04:00:00Z",
            "value": 1217
        }
    ]
}    

Note: In this example, the response returned two different values for that particular metric. The response for this and some other Metrics Service API calls will return as many values as there are available - one value for each time the metric has changed.

UserGroupCount

This API call returns the number of user groups per application namespace.

Endpoints

Two forms of endpoints are available:

GET /metricsvc/api/v1/metrics/dtplatform.passportsvc.UserGroupCount?{dimensions}

GET /metricsvc/api/v1/metrics/dtplatform.passportsvc.UserGroupCount/by-dimension;{dimensions}?{period parameters}

Request

Query parameters

Parameter	Type	Description	Required
namespace	String	Filter by application namespace.	Required

Example:

This example shows a request to return the UserGroupCount for the namespace called digitaltwin_883WeSED

GET /metricsvc/api/v1/metrics/dtplatform.passportsvc.UserGroupCount?namespace=digitaltwin_883WeSED

Response

This example response shows that number of user groups in the digitaltwin_883WeSED application namespace was counted as 65 at 12:00 on 25th July.

{
    "metricName": "dtplatform.passportsvc.UserGroupCount",
    "dimensions": {
        "namespace": "digitaltwin_883WeSED"
    },
    "metrics": [
        {
            "timestamp": "2024-07-25T12:00:00Z",
            "value": 65
        },
    ]
}    

UserCount

This API call returns the number of users in the entire system. This is only available to the Platform Manager.

Endpoints

Two forms of endpoints are available:

GET /metricsvc/api/v1/metrics/dtplatform.passportsvc.UserCount

GET /metricsvc/api/v1/metrics/dtplatform.passportsvc.UserCount/by-dimension?{period parameters}

ApplicationCount

This API call returns the number of applications in the entire system. This is only available to the Platform Manager.

Endpoints

Two forms of endpoints are available:

GET /metricsvc/api/v1/metrics/dtplatform.passportsvc.ApplicationCount

GET /metricsvc/api/v1/metrics/dtplatform.passportsvc.ApplicationCount/by-dimension?{period parameters}