Sample adapter configuration

This section documents the configuration models and settings used by the WeatherGov sample adapter. Use the following to understand how to configure connectivity to the Weather.gov service, select stations and measurement data to collect, define collection schedules, and configure discovery behavior.

Data source

The data source controls how the adapter connects to and polls the weather service.

• baseUrl (default https://api.weather.gov) - Base URL of the weather service. Must be HTTPS unless allowInsecureBaseUrl is enabled.

• requestTimeoutMs (default 10000) - HTTP request timeout in milliseconds. Must be greater than 0.

• maxRetries (default 3) - Maximum number of retry attempts for transient HTTP failures. Cannot be negative.

• retryBackoffMs (default 1000) - Base backoff, in milliseconds, between retry attempts. Cannot be negative.

• userAgent (default WeatherGovAdapterSample/1.0 (support@example.com)) - User-Agent header sent with each request. Required by api.weather.gov.

• streamIdPrefix (default weathergov) - Prefix applied to generated stream IDs.

• dropNullMeasurements (default true) - When true, null measurement values are not emitted.

• allowInsecureBaseUrl (default false) - Allows a non-TLS (HTTP) base URL. For local development and testing only; must remain false in production.

Data selection

Selects which stations and measurement fields are collected and how their streams are named.

• stationId (required) - Station ID to collect. For example, KSEA.

• includeFields (default []) - Measurement fields to include (for example, temperature_c, wind_speed_mps). If this is left empty, all supported fields are included.

• scheduleId (required) - ID of the collection schedule for this station. One of 1 (1 min), 2 (5 min), or 3 (10 min); periods are defined in the Schedules facet.

Schedules

Collection cadence is set through the framework Schedules facet and not the data source. Each entry maps a schedule ID to a period; data selection items reference one via scheduleId. See the ConfigurationExamples/WeatherGov.Schedules.json.

• id (required) - Schedule ID referenced by scheduleId (1, 2, or 3).

• period (required) - Collection interval as an hh:mm:ss TimeSpan (for example, 00:01:00 for one minute).