GetMetricsAsync()

Gets the metrics of the Milvus server.

public async Task<GetMetricsResp> GetMetricsAsync(GetMetricsReq request, CancellationToken cancellationToken = default)

Request Syntax

var request = new GetMetricsReq
{
    Request = "{\"metric_type\":\"system_info\"}"
};

GetMetricsResp result = await client.GetMetricsAsync(request);

REQUEST PARAMETERS:

  • Request (string) -

    The metric request string, e.g. {"metric_type":"system_info"} (the server requires a JSON object carrying a metric_type or req_type key).

RETURN TYPE:

Task

RETURNS:

A GetMetricsResp object that contains the metrics payload and the component that produced it.

GetMetricsResp
    Response       // -> string
    ComponentName  // -> string

PARAMETERS:

  • Response (string) -

    The metrics payload, in the server’s configured metrics format.

  • ComponentName (string) -

    The name of the component that produced the metrics.

EXCEPTIONS:

  • MilvusException

    Thrown when the RPC fails or the server returns an error. Inspect the exception message for details.

Example

using Milvus.Client.V2;
using Milvus.Client.V2.Requests.Utility;
using Milvus.Client.V2.Responses.Utility;

using var client = new MilvusClientV2(new ConnectConfig
{
    Uri = "localhost:19530",
    Username = "root",
    Password = "Milvus"
});
await client.ConnectAsync();

GetMetricsResp result = await client.GetMetricsAsync(new GetMetricsReq
{
    Request = "{\"metric_type\":\"system_info\"}"
});

Console.WriteLine(result.Response);

Try Managed Milvus for Free

Zilliz Cloud is hassle-free, powered by Milvus and 10x faster.

Get Started
Feedback

Was this page helpful?