Skip to content

Commit

Permalink
feat(datadog): add support for inline template (#657)
Browse files Browse the repository at this point in the history
* feat(datadog): add support for inline template

* test(datadog): add tests for datadog query when custom inline templates are specified
  • Loading branch information
anthonywoo authored and fieldju committed Jan 28, 2020
1 parent b28c669 commit 3550a31
Show file tree
Hide file tree
Showing 3 changed files with 98 additions and 6 deletions.
Expand Up @@ -18,14 +18,14 @@

import com.fasterxml.jackson.annotation.JsonTypeName;
import com.netflix.kayenta.canary.CanaryMetricSetQueryConfig;
import javax.validation.constraints.NotNull;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.ToString;
import org.springframework.util.StringUtils;

@Builder
@Builder(toBuilder = true)
@ToString
@NoArgsConstructor
@AllArgsConstructor
Expand All @@ -34,7 +34,22 @@ public class DatadogCanaryMetricSetQueryConfig implements CanaryMetricSetQueryCo

public static final String SERVICE_TYPE = "datadog";

@NotNull @Getter private String metricName;
@Getter private String metricName;

@Getter private String customInlineTemplate;

@Getter private String customFilterTemplate;

@Override
public CanaryMetricSetQueryConfig cloneWithEscapedInlineTemplate() {
if (StringUtils.isEmpty(customInlineTemplate)) {
return this;
} else {
return this.toBuilder()
.customInlineTemplate(customInlineTemplate.replace("${", "$\\{"))
.build();
}
}

@Override
public String getServiceType() {
Expand Down
Expand Up @@ -20,6 +20,7 @@
import com.netflix.kayenta.canary.CanaryMetricConfig;
import com.netflix.kayenta.canary.CanaryScope;
import com.netflix.kayenta.canary.providers.metrics.DatadogCanaryMetricSetQueryConfig;
import com.netflix.kayenta.canary.providers.metrics.QueryConfigUtils;
import com.netflix.kayenta.datadog.security.DatadogCredentials;
import com.netflix.kayenta.datadog.security.DatadogNamedAccountCredentials;
import com.netflix.kayenta.datadog.service.DatadogRemoteService;
Expand All @@ -32,6 +33,7 @@
import com.netflix.kayenta.security.AccountCredentialsRepository;
import com.netflix.kayenta.security.CredentialsHelper;
import com.netflix.spectator.api.Registry;
import java.io.IOException;
import java.time.Instant;
import java.util.ArrayList;
import java.util.Collections;
Expand Down Expand Up @@ -76,19 +78,31 @@ public String buildQuery(
String metricsAccountName,
CanaryConfig canaryConfig,
CanaryMetricConfig canaryMetricConfig,
CanaryScope canaryScope) {
CanaryScope canaryScope)
throws IOException {

DatadogCanaryMetricSetQueryConfig queryConfig =
(DatadogCanaryMetricSetQueryConfig) canaryMetricConfig.getQuery();
String[] baseScopeAttributes = new String[] {"scope", "location"};

String customFilter =
QueryConfigUtils.expandCustomFilter(
canaryConfig, queryConfig, canaryScope, baseScopeAttributes);

return queryConfig.getMetricName() + "{" + canaryScope.getScope() + "}";
if (StringUtils.isEmpty(customFilter)) {
return queryConfig.getMetricName() + "{" + canaryScope.getScope() + "}";
} else {
return customFilter;
}
}

@Override
public List<MetricSet> queryMetrics(
String accountName,
CanaryConfig canaryConfig,
CanaryMetricConfig canaryMetricConfig,
CanaryScope canaryScope) {
CanaryScope canaryScope)
throws IOException {
DatadogNamedAccountCredentials accountCredentials =
(DatadogNamedAccountCredentials)
accountCredentialsRepository
Expand Down
@@ -0,0 +1,63 @@
/*
* Copyright 2020 Zendesk Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License")
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package com.netflix.kayenta.datadog.metrics

import com.netflix.kayenta.canary.CanaryConfig
import com.netflix.kayenta.canary.CanaryMetricConfig
import com.netflix.kayenta.canary.providers.metrics.DatadogCanaryMetricSetQueryConfig
import com.netflix.kayenta.datadog.canary.DatadogCanaryScope
import spock.lang.Shared
import spock.lang.Specification
import spock.lang.Unroll

class DatadogMetricsServiceSpec extends Specification {

@Shared
DatadogMetricsService datadogMetricsService = DatadogMetricsService.builder().build()

@Unroll
void "Can dry-run query generation"() {
given:
DatadogCanaryMetricSetQueryConfig queryConfig =
DatadogCanaryMetricSetQueryConfig.builder()
.metricName(metricName)
.customInlineTemplate(customInlineTemplate)
.build()
CanaryMetricConfig canaryMetricConfig =
CanaryMetricConfig.builder()
.query(queryConfig)
.build()
CanaryConfig canaryConfig =
CanaryConfig.builder()
.metric(canaryMetricConfig)
.build()
DatadogCanaryScope datadogCanaryScope =
new DatadogCanaryScope()
.setScope(scope)

when:
String query = datadogMetricsService.buildQuery(null, canaryConfig, canaryMetricConfig, datadogCanaryScope)

then:
query == expectedQuery

where:
metricName | customInlineTemplate | scope | extendedScopeParams || expectedQuery
"sum:app.errors" | null | "tag:some-tag" | null || 'sum:app.errors{tag:some-tag}'
null | 'sum:app.errors{${scope}}/sum:app.requests{${scope}}' | "tag:some-tag" | null || 'sum:app.errors{tag:some-tag}/sum:app.requests{tag:some-tag}'
}
}

0 comments on commit 3550a31

Please sign in to comment.