Skip to content

Latest commit

 

History

History
275 lines (178 loc) · 7.37 KB

MetricsApi.md

File metadata and controls

275 lines (178 loc) · 7.37 KB
Raw

\MetricsApi

All URIs are relative to http://localhost

Method HTTP request Description
GetChainMessageMetrics Get /v1/metrics/chain/{chainID}/messages Get chain specific message metrics.
GetChainPipeMetrics Get /v1/metrics/chain/{chainID}/pipe Get chain pipe event metrics.
GetChainWorkflowMetrics Get /v1/metrics/chain/{chainID}/workflow Get chain workflow metrics.
GetNodeMessageMetrics Get /v1/metrics/node/messages Get accumulated message metrics.

GetChainMessageMetrics

ChainMessageMetrics GetChainMessageMetrics(ctx, chainID).Execute()

Get chain specific message metrics.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    chainID := "chainID_example" // string | ChainID (Bech32)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.MetricsApi.GetChainMessageMetrics(context.Background(), chainID).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `MetricsApi.GetChainMessageMetrics``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetChainMessageMetrics`: ChainMessageMetrics
    fmt.Fprintf(os.Stdout, "Response from `MetricsApi.GetChainMessageMetrics`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
chainID string ChainID (Bech32)

Other Parameters

Other parameters are passed through a pointer to a apiGetChainMessageMetricsRequest struct via the builder pattern

Name Type Description Notes

Return type

ChainMessageMetrics

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetChainPipeMetrics

ConsensusPipeMetrics GetChainPipeMetrics(ctx, chainID).Execute()

Get chain pipe event metrics.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    chainID := "chainID_example" // string | ChainID (Bech32)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.MetricsApi.GetChainPipeMetrics(context.Background(), chainID).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `MetricsApi.GetChainPipeMetrics``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetChainPipeMetrics`: ConsensusPipeMetrics
    fmt.Fprintf(os.Stdout, "Response from `MetricsApi.GetChainPipeMetrics`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
chainID string ChainID (Bech32)

Other Parameters

Other parameters are passed through a pointer to a apiGetChainPipeMetricsRequest struct via the builder pattern

Name Type Description Notes

Return type

ConsensusPipeMetrics

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetChainWorkflowMetrics

ConsensusWorkflowMetrics GetChainWorkflowMetrics(ctx, chainID).Execute()

Get chain workflow metrics.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    chainID := "chainID_example" // string | ChainID (Bech32)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.MetricsApi.GetChainWorkflowMetrics(context.Background(), chainID).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `MetricsApi.GetChainWorkflowMetrics``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetChainWorkflowMetrics`: ConsensusWorkflowMetrics
    fmt.Fprintf(os.Stdout, "Response from `MetricsApi.GetChainWorkflowMetrics`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
chainID string ChainID (Bech32)

Other Parameters

Other parameters are passed through a pointer to a apiGetChainWorkflowMetricsRequest struct via the builder pattern

Name Type Description Notes

Return type

ConsensusWorkflowMetrics

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetNodeMessageMetrics

NodeMessageMetrics GetNodeMessageMetrics(ctx).Execute()

Get accumulated message metrics.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.MetricsApi.GetNodeMessageMetrics(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `MetricsApi.GetNodeMessageMetrics``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetNodeMessageMetrics`: NodeMessageMetrics
    fmt.Fprintf(os.Stdout, "Response from `MetricsApi.GetNodeMessageMetrics`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiGetNodeMessageMetricsRequest struct via the builder pattern

Return type

NodeMessageMetrics

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]