GraphQL+Spring Boot：如何收集（错误）度量？

Question

在阅读了以下文档之后，我设法将基本的graphql.timer.query.*指标发送到Datadog

• https://www.baeldung.com/spring-boot-actuators
• https://docs.spring.io/spring-boot/docs/2.0.x/actuator-api/html/#metrics
• https://github.com/graphql-java-kickstart/graphql-spring-boot#跟踪和度量

到目前为止，我所实现的是，当我发送GraphQL查询/突变时，我会相应地收集请求计数和时间。例如，发送以下查询

query HelloWorldQuery {
  greeting(
    name: "Bob"
  ) {
    message
  }
}

我将看到metricsgraphql.timer.query.count/graphql.timer.query.sum带有标记operationname=helloworldquery

它工作得很好，直到我想测试一个有错误的查询。我意识到没有与失败查询相关的度量/标记。例如，如果上面的查询返回null数据和一些GraphQL错误，我仍然会收集GraphQL.timer.query.count(operationname=helloworldquery)，但是没有其他标记来告诉我该查询有错误。

在网关中，我实现了一个自定义的GraphQlerrorHandler，所以我想也许应该在该类中添加错误计数器（通过MeterRegistry），但是我无法简单地从GraphQLError类型获取OperationName。我能得到的最好的结果是error.getpath()，它给出了方法名（例如greeting)，而不是自定义查询名(HelloWorldQuery-与graphql.timer.query.*提供的一致）。

我的问题是，如何解决上述问题？一般来说，收集GraphQL查询度量（包括错误）的最佳方式是什么？

----------更新------------------------------------------------------------------

2020-01-02我试图吸收我的CustomMetricsInstrumentation类，但没有成功。有内部自动配置布线，我不能在中间插入我的自动配置。

Answer 1

您可以使用自己的实现重写默认的TracingInstrumentation。由于GraphQLInstrumentationAutoConfiguration类中的@ConditionalOnMissingBean注释，它将被自动选择。下面是一个简单的示例，它添加了两个自定义度量：graphql.counter.query.success和graphql.counter.query.error：

@Component
public class CustomMetricsInstrumentation extends TracingInstrumentation {

    private static final String QUERY_STATUS_COUNTER_METRIC_NAME = "graphql.counter.query";
    private static final String OPERATION_NAME_TAG = "operationName";
    private static final String UNKNOWN_OPERATION_NAME = "unknown";

    private MeterRegistry meterRegistry;

    public CustomMetricsInstrumentation(MeterRegistry meterRegistry) {
        this.meterRegistry = meterRegistry;
    }

    @Override
    public CompletableFuture<ExecutionResult> instrumentExecutionResult(ExecutionResult executionResult,
                                                                        InstrumentationExecutionParameters parameters) {

        String status = CollectionUtils.isEmpty(executionResult.getErrors()) ? "success" : "error";
        String operation = parameters.getOperation() != null ? parameters.getOperation() : UNKNOWN_OPERATION_NAME;
        Collection<Tag> tags = Arrays.asList(Tag.of(OPERATION_NAME_TAG, operation));

        meterRegistry.counter(QUERY_STATUS_COUNTER_METRIC_NAME + "." + status, tags).increment();

        return super.instrumentExecutionResult(executionResult, parameters);
    }
}

我的应用程序。yaml，以防万一：

graphql:
  servlet:
    tracing-enabled: true
    actuator-metrics: true
management:
  endpoint:
  metrics:
    enabled: true
  endpoints:
    web:
      exposure:
        include: health,metrics

我使用的是spring-boot-starter-parent:2.2.2。release,graphql-spring-boot-starter:6.0.0