Interface Metrics

Returns Result<SessionMetricCollectorList>

a Result that completes when a response is received from the server.

If the task completes successfully, the result will be a list of current session metric collectors.

Otherwise, the Result will reject with an Error. Common reasons for failure include:

• if the calling session does not have VIEW_SERVER permission;
• if the session is closed.

Returns Result<TopicMetricCollectorList>

a Result that completes when a response is received from the server.

If the task completes successfully, the result will be a list of current topic metric collectors.

Otherwise, the Result will reject with an Error. Common reasons for failure include:

• if the calling session does not have VIEW_SERVER permission;
• if the session is closed.

Returns MetricsRequest

a new MetricsRequest

Parameters

• collector: SessionMetricCollector

Returns Result<any>

a Result that resolves when a response is received from the server.

If the task completes successfully, the result will be null. The result type is any rather than void to provide forward compatibility with future iterations of this API that may provide a non-null result with a more specific result type.

Otherwise, the Result will reject with an Error. Common reasons for failure include:

• if the metric collector session filter is invalid;
• if the calling session does not have CONTROL_SERVER permission;
• if the operation failed due to a transient cluster error;
• if the session is closed.
• NullValueError – if the collector is null or undefined

Parameters

• collector: TopicMetricCollector

Returns Result<any>

a Result that resolves when a response is received from the server.

If the task completes successfully, the result will be null. The result type is any rather than void to provide forward compatibility with future iterations of this API that may provide a non-null result with a more specific result type.

Otherwise, the Result will reject with an Error. Common reasons for failure include:

• if the metric collector session filter is invalid;
• if the calling session does not have CONTROL_SERVER permission;
• if the operation failed due to a transient cluster error;
• if the session is closed.
• NullValueError – if the collector is null or undefined

Parameters

• name: string

Returns Result<any>

a Result that resolves when a response is received from the server.

If the task completes successfully, the result will be null. The result type is any rather than void to provide forward compatibility with future iterations of this API that may provide a non-null result with a more specific result type.

Otherwise, the Result will reject with an Error. Common reasons for failure include:

• if the calling session does not have CONTROL_SERVER permission;
• if the operation failed due to a transient cluster error;
• if the session is closed.
• NullValueError – if the name is null or undefined

Parameters

• name: string

Returns Result<any>

a Result that resolves when a response is received from the server.

If the task completes successfully, the result will be null. The result type is any rather than void to provide forward compatibility with future iterations of this API that may provide a non-null result with a more specific result type.

Otherwise, the Result will reject with an Error. Common reasons for failure include:

• if the calling session does not have CONTROL_SERVER permission;
• if the operation failed due to a transient cluster error;
• if the session is closed.
• NullValueError – if the collector is null or undefined