metrics[*].scraping.schedule is not optional

Report

In the docs here, it mentions this:

Additionally, the following fields are optional: …

• scraping.schedule - A scraping schedule for the individual metric; overrides the the one specified in metricDefaults

However I receive various when this field is omitted.

Expected Behavior

If a metric is missing a scraping schedule, the metric default schedule should be used.

Actual Behavior

If the scraping block is omitted entirely from a metric, this error is thrown:

System.ArgumentNullException: [scraping] cannot be Null. (Parameter 'scraping')
   at GuardNet.Guard.For[TException](Func`1 predicate, TException exception)
   at GuardNet.Guard.NotNull[TParam,TException](TParam param, TException exception)
   at GuardNet.Guard.NotNull[TParam](TParam param, String paramName, String message)
   at GuardNet.Guard.NotNull[TParam](TParam param, String paramName)
   at Promitor.Core.Scraping.Configuration.Model.Metrics.ScrapeDefinition`1..ctor(AzureMetricConfiguration azureMetricConfiguration, PrometheusMetricDefinition prometheusMetricDefinition, Scraping scraping, TResourceDefinition resource, String subscriptionId, String resourceGroupName) in /src/Promitor.Core.Scraping/Model/Metrics/ScrapeDefinition.cs:line 34
   at Promitor.Core.Scraping.Configuration.Model.Metrics.MetricDefinition.CreateScrapeDefinition(IAzureResourceDefinition resource, AzureMetadata azureMetadata) in /src/Promitor.Core.Scraping/Model/Metrics/MetricDefinition.cs:line 74
   at Microsoft.Extensions.DependencyInjection.SchedulingExtensions.ScheduleResourceScraping(IAzureResourceDefinition resource, AzureMetadata azureMetadata, MetricDefinition metric, AzureMonitorClientFactory azureMonitorClientFactory, MetricSinkWriter metricSinkWriter, IRuntimeMetricsCollector runtimeMetricCollector, IConfiguration configuration, IOptions`1 azureMonitorLoggingConfiguration, ILoggerFactory loggerFactory, ILogger`1 logger, IServiceCollection services) in /src/Promitor.Agents.Scraper/SchedulingExtensions.cs:line 69
   at Microsoft.Extensions.DependencyInjection.SchedulingExtensions.ScheduleMetricScraping(IServiceCollection services) in /src/Promitor.Agents.Scraper/SchedulingExtensions.cs:line 34
   at Promitor.Agents.Scraper.Startup.ConfigureServices(IServiceCollection services) in /src/Promitor.Agents.Scraper/Startup.cs:line 55
   at System.RuntimeMethodHandle.InvokeMethod(Object target, Object[] arguments, Signature sig, Boolean constructor, Boolean wrapExceptions)
   at System.Reflection.RuntimeMethodInfo.Invoke(Object obj, BindingFlags invokeAttr, Binder binder, Object[] parameters, CultureInfo culture)
   at Microsoft.AspNetCore.Hosting.ConfigureServicesBuilder.InvokeCore(Object instance, IServiceCollection services)
   at Microsoft.AspNetCore.Hosting.ConfigureServicesBuilder.<>c__DisplayClass9_0.<Invoke>g__Startup|0(IServiceCollection serviceCollection)
   at Microsoft.AspNetCore.Hosting.ConfigureServicesBuilder.Invoke(Object instance, IServiceCollection services)
   at Microsoft.AspNetCore.Hosting.ConfigureServicesBuilder.<>c__DisplayClass8_0.<Build>b__0(IServiceCollection services)
   at Microsoft.AspNetCore.Hosting.GenericWebHostBuilder.UseStartup(Type startupType, HostBuilderContext context, IServiceCollection services)
   at Microsoft.AspNetCore.Hosting.GenericWebHostBuilder.<>c__DisplayClass12_0.<UseStartup>b__0(HostBuilderContext context, IServiceCollection services)
   at Microsoft.Extensions.Hosting.HostBuilder.CreateServiceProvider()
   at Microsoft.Extensions.Hosting.HostBuilder.Build()
   at Promitor.Agents.Scraper.Program.Main(String[] args) in /src/Promitor.Agents.Scraper/Program.cs:line 35

I’ve not found a way to omit this, instead I’m just duplicating the default to each metric like this:

    version: v1
    azureMetadata:
      tenantId: "tenant"
      subscriptionId: "sub"
      resourceGroupName: "group"
    metricDefaults:
      aggregation:
        interval: "00:05:00"
      scraping:
        schedule: "*/1 * * * *" # DUPLICATED
    metrics:
    # Loadbalancer metrics, for each aggregation and metric combination
    - name: "name"
      description: "desc"
      scraping:
        schedule: "*/1 * * * *" # DUPLICATED
      resourceType: "Generic"
      labels:
        a: "b"
      azureMetricConfiguration:
        metricName: "foo"
        aggregation:
          type: "Average"
      resources:
      - resourceGroupName: "group"
        resourceUri: "uri"

I’ve tried to set scraping to ~ or {} too.

Steps to Reproduce the Problem

1. Use a metrics-declaration.yaml config file.
2. Omit the scraping field from a metric, e.g.:

    version: v1
    azureMetadata:
      tenantId: "tenant"
      subscriptionId: "sub"
      resourceGroupName: "group"
    metricDefaults:
      aggregation:
        interval: "00:05:00"
      scraping:
        schedule: "*/1 * * * *" # DUPLICATED
    metrics:
    # Loadbalancer metrics, for each aggregation and metric combination
    - name: "name"
      description: "desc"
      #scraping:
      # schedule: "*/1 * * * *" # DUPLICATED
      resourceType: "Generic"
      labels:
        a: "b"
      azureMetricConfiguration:
        metricName: "foo"
        aggregation:
          type: "Average"
      resources:
      - resourceGroupName: "group"
        resourceUri: "uri"

Component

Scraper

Version

2.3.0

Configuration

Configuration:

# Add your scraping configuration here

Logs

example

Platform

Microsoft Azure

Contact Details

[e-mail]

[tomkerkhove]

Odd because I don’t use it myself: https://github.com/tomkerkhove/promitor/blob/master/config/promitor/scraper/metrics.yaml

I’ll try to reproduce and see what is causing this.

[tomkerkhove]

Another case that triggered this:

metrics:
  - name: promitor_demo_cdn_requests_declared
    description: "Amount of requests at the origin of our Azure CDN"
    resourceType: Cdn
    azureMetricConfiguration:
      metricName: OriginRequestCount
      aggregation:
        type: Total
    resources:
-    - name: promitor-testing-resource-us-cdn
+    - cdnName: promitor-testing-resource-us-cdn
      resourceGroupName: promitor-testing-infrastructure-us