Loading

TSDB (time-series database mode)

TSDB mode optimizes data streams for metrics storage. It requires at least one dimension field and a timestamp, enabling Elasticsearch to apply time-series specific optimizations (sorted indices, doc-value-only fields, synthetic _source).

  • [Timestamp] field (required for all data streams)
  • At least one [Dimension] field (identifies the time-series)
  • EntityTarget.DataStream with DataStreamMode.Tsdb
public class MetricEvent
{
    [Timestamp]
    [JsonPropertyName("@timestamp")]
    public DateTimeOffset Timestamp { get; set; }

    [Dimension]
    [Keyword]
    public string Host { get; set; }

    [Dimension]
    [Keyword]
    public string MetricName { get; set; }

    public double Value { get; set; }

    [Keyword]
    public string Unit { get; set; }
}

Dimension fields identify what the metric is about (host, service, metric name). The combination of dimensions and timestamp uniquely identifies a data point.

[ElasticsearchMappingContext]
[Entity<MetricEvent>(
    Target = EntityTarget.DataStream,
    DataStreamType = "metrics",
    DataStreamDataset = "myapp",
    DataStreamNamespace = "production",
    DataStreamMode = DataStreamMode.Tsdb
)]
public static partial class MetricsContext;
		
var strategy = IngestStrategies.DataStream<MetricEvent>(MetricsContext.MetricEvent.Context, "90d");
var options = new IngestChannelOptions<MetricEvent>(transport, strategy, MetricsContext.MetricEvent.Context);
using var channel = new IngestChannel<MetricEvent>(options);

await channel.BootstrapElasticsearchAsync(BootstrapMethod.Failure);
  • Storage efficiency: sorted indices and synthetic _source reduce storage significantly
  • Automatic deduplication: documents with the same dimensions and timestamp are deduplicated
  • Downsampling support: Elasticsearch can aggregate old data into lower-resolution summaries