Version: v5.0

IafUsageMetrics

Use the IafUsageMetrics API to retrieve metrics information.

getEntityCountByMetric#

Gets a specific metric value by metric name.

Parameter	Required	Type	Description
ctx	No	Ctx	Context storage that contains data, such as authorization token requirements, namespaces, or session storage.
name	Yes	String	Metric identifier from the usage metrics catalogue.

Returns

(Number | UNKNOWN: UndefinedLiteral) - Metric count value when found; otherwise .

Examples

// FileCount is exported from this module for convenience.const fileCount = await IafUsageMetrics.getEntityCountByMetric(ctx, FileCount);

getFileCount#

Gets file count for a particular namespace.

Parameter	Required	Type	Description
ctx	No	Ctx	Context storage that contains data, such as authorization token requirements, namespaces, or session storage.

Returns

Number - number of files

Examples

const fileCount = await IafUsageMetrics.getFileCount(ctx);

getFileCountGraphics#

Gets graphics file count for a particular namespace.

Parameter	Required	Type	Description
ctx	No	Ctx	Context storage that contains data, such as authorization token requirements, namespaces, or session storage.

Returns

Number - number of graphics files

Examples

const graphicsFileCount = await IafUsageMetrics.getFileCountGraphics(ctx);

getFileVersionCount#

Gets file version count for a particular namespace.

Parameter	Required	Type	Description
ctx	No	Ctx	Context storage that contains data, such as authorization token requirements, namespaces, or session storage.

Returns

Number - number of file versions

Examples

const fileVersionCount = await IafUsageMetrics.getFileVersionCount(ctx);

getFileVersionCountGraphics#

Gets graphics file version count for a particular namespace.

Parameter	Required	Type	Description
ctx	No	Ctx	Context storage that contains data, such as authorization token requirements, namespaces, or session storage.

Returns

Number - number of graphics file versions

Examples

const graphicsVersionCount = await IafUsageMetrics.getFileVersionCountGraphics(ctx);

getFileVersionSize#

Gets file version size for a particular namespace.

Parameter	Required	Type	Description
ctx	No	Ctx	Context storage that contains data, such as authorization token requirements, namespaces, or session storage.

Returns

Number - size of file versions

Examples

const fileVersionSize = await IafUsageMetrics.getFileVersionSize(ctx);

getFileVersionSizeGraphics#

Gets graphics file version size for a particular namespace.

Parameter	Required	Type	Description
ctx	No	Ctx	Context storage that contains data, such as authorization token requirements, namespaces, or session storage.

Returns

Number - size of graphics file versions

Examples

const graphicsVersionSize = await IafUsageMetrics.getFileVersionSizeGraphics(ctx);

getGeneralMetrics#

Gets general metrics from a particular application and/or workspace.

Parameter	Required	Type	Description
ctx	No	Ctx	Context storage that contains data, such as authorization token requirements, namespaces, or session storage.

Returns

Object - metrics object

Examples

const metrics = await IafUsageMetrics.getGeneralMetrics(ctx);// metrics.metrics could include entries such as  {   metrics: [{     metricName: "dtplatform.passportsvc.WorkspaceCount",     value: 12   },{     metricName: "dtplatform.passportsvc.UserGroupCount",     value: 32},{     metricName: "dtplatform.passportsvc.UserConfigCount",     value: 32}]}

getNamedFileCollectionCount#

Gets named file collection count for a particular namespace.

Parameter	Required	Type	Description
ctx	No	Ctx	Context storage that contains data, such as authorization token requirements, namespaces, or session storage.

Returns

Number - number of named file collections

Examples

const fileCollectionCount = await IafUsageMetrics.getNamedFileCollectionCount(ctx);

getNamedFileCollectionRelatedItemCount#

Gets named file collection related item count for a particular namespace.

Parameter	Required	Type	Description
ctx	No	Ctx	Context storage that contains data, such as authorization token requirements, namespaces, or session storage.

Returns

Number - number of named file collection related items

Examples

const fileCollectionRelatedItemCount = await IafUsageMetrics.getNamedFileCollectionRelatedItemCount(ctx);

getNamedFileCollectionVersionCount#

Gets named file collection version count for a particular namespace.

Parameter	Required	Type	Description
ctx	No	Ctx	Context storage that contains data, such as authorization token requirements, namespaces, or session storage.

Returns

Number - number of named file collection versions

Examples

const fileCollectionVersionCount = await IafUsageMetrics.getNamedFileCollectionVersionCount(ctx);

getNamedFileCollectionVersionSize#

Gets named file collection version size for a particular namespace.

Parameter	Required	Type	Description
ctx	No	Ctx	Context storage that contains data, such as authorization token requirements, namespaces, or session storage.

Returns

Number - size of named file collection versions

Examples

const fileCollectionVersionSize = await IafUsageMetrics.getNamedFileCollectionVersionSize(ctx);

getNamedTelemetryCollectionCount#

Gets named telemetry collection count for a particular namespace.

Parameter	Required	Type	Description
ctx	No	Ctx	Context storage that contains data, such as authorization token requirements, namespaces, or session storage.

Returns

Number - number of named telemetry collections

Examples

const telemetryCollectionCount = await IafUsageMetrics.getNamedTelemetryCollectionCount(ctx);

getNamedTelemetryCollectionRelatedItemCount#

Gets named telemetry collection related item count for a particular namespace.

Parameter	Required	Type	Description
ctx	No	Ctx	Context storage that contains data, such as authorization token requirements, namespaces, or session storage.

Returns

Number - number of named telemetry collection related items

Examples

const telemetryRelatedItemCount = await IafUsageMetrics.getNamedTelemetryCollectionRelatedItemCount(ctx);

getNamedTelemetryCollectionTimeSeriesSize#

Gets named telemetry collection time series collection size for a particular namespace.

Parameter	Required	Type	Description
ctx	No	Ctx	Context storage that contains data, such as authorization token requirements, namespaces, or session storage.

Returns

Number - size of named telemetry collection time series collections

Examples

const telemetryTimeSeriesSize = await IafUsageMetrics.getNamedTelemetryCollectionTimeSeriesSize(ctx);

getNamedTelemetryCollectionVersionCount#

Gets named telemetry collection version count for a particular namespace.

Parameter	Required	Type	Description
ctx	No	Ctx	Context storage that contains data, such as authorization token requirements, namespaces, or session storage.

Returns

Number - number of named telemetry collection versions

Examples

const telemetryVersionCount = await IafUsageMetrics.getNamedTelemetryCollectionVersionCount(ctx);

getNamedTelemetryCollectionVersionSize#

Gets named telemetry collection version size for a particular namespace.

Parameter	Required	Type	Description
ctx	No	Ctx	Context storage that contains data, such as authorization token requirements, namespaces, or session storage.

Returns

Number - size of named telemetry collection versions

Examples

const telemetryVersionSize = await IafUsageMetrics.getNamedTelemetryCollectionVersionSize(ctx);

getNamedUserCollectionCount#

Gets named user collection count for a particular namespace.

Parameter	Required	Type	Description
ctx	No	Ctx	Context storage that contains data, such as authorization token requirements, namespaces, or session storage.

Returns

Number - number of named user collections

Examples

const collectionCount = await IafUsageMetrics.getNamedUserCollectionCount(ctx);

getNamedUserCollectionRelatedItemCount#

Gets named user collection related item count for a particular namespace.

Parameter	Required	Type	Description
ctx	No	Ctx	Context storage that contains data, such as authorization token requirements, namespaces, or session storage.

Returns

Number - number of named user collection related items

Examples

const relatedItemCount = await IafUsageMetrics.getNamedUserCollectionRelatedItemCount(ctx);

getNamedUserCollectionVersionCount#

Gets named user collection version count for a particular namespace.

Parameter	Required	Type	Description
ctx	No	Ctx	Context storage that contains data, such as authorization token requirements, namespaces, or session storage.

Returns

Number - number of named user collection versions

Examples

const versionCount = await IafUsageMetrics.getNamedUserCollectionVersionCount(ctx);

getNamedUserCollectionVersionSize#

Gets named user collection version size for a particular namespace.

Parameter	Required	Type	Description
ctx	No	Ctx	Context storage that contains data, such as authorization token requirements, namespaces, or session storage.

Returns

Number - size of named user collection versions

Examples

const versionSize = await IafUsageMetrics.getNamedUserCollectionVersionSize(ctx);

getPreviewImageFileSize#

Gets preview image file size for a particular namespace.

Parameter	Required	Type	Description
ctx	No	Ctx	Context storage that contains data, such as authorization token requirements, namespaces, or session storage.

Returns

Number - size of preview image files

Examples

const previewImageSize = await IafUsageMetrics.getPreviewImageFileSize(ctx);

getScriptCount#

Gets script count for a particular namespace.

Parameter	Required	Type	Description
ctx	No	Ctx	Context storage that contains data, such as authorization token requirements, namespaces, or session storage.

Returns

Number - number of scripts

Examples

const scriptCount = await IafUsageMetrics.getScriptCount(ctx);

getScriptVersionSize#

Gets script version size for a particular namespace.

Parameter	Required	Type	Description
ctx	No	Ctx	Context storage that contains data, such as authorization token requirements, namespaces, or session storage.

Returns

Number - size of script versions

Examples

const scriptVersionSize = await IafUsageMetrics.getScriptVersionSize(ctx);

getUserConfigCount#

Gets user config count for a particular namespace.

Parameter	Required	Type	Description
ctx	No	Ctx	Context storage that contains data, such as authorization token requirements, namespaces, or session storage.

Returns

Number - number of user configs

Examples

const userConfigCount = await IafUsageMetrics.getUserConfigCount(ctx);

getUserConfigVersionSize#

Gets user config version size for a particular namespace.

Parameter	Required	Type	Description
ctx	No	Ctx	Context storage that contains data, such as authorization token requirements, namespaces, or session storage.

Returns

Number - size of user config versions

Examples

const userConfigVersionSize = await IafUsageMetrics.getUserConfigVersionSize(ctx);

getUsergroupCountByApplication#

Gets user group count for a particular application.

Parameter	Required	Type	Description
ctx	No	Ctx	Context storage that contains data, such as authorization token requirements, namespaces, or session storage.

Returns

Number - number of user groups

Examples

const userGroupCount = await IafUsageMetrics.getUsergroupCountByApplication(ctx);

getWorkspaceCountByApplication#

Gets workspace count from a particular application.

Parameter	Required	Type	Description
ctx	No	Ctx	Context storage that contains data, such as authorization token requirements, namespaces, or session storage.

Returns

Number - number of workspaces

Examples

const workspaceCount = await IafUsageMetrics.getWorkspaceCountByApplication(ctx);