TLD filter plugin

Parses a URL or hostname and writes the top-level domain, registered domain, and subdomain components into structured fields.

• Package: logstash-filter-tld
• Coverage source: default/bundled
• Official catalog entry: Yes

Plugin overview

tld is used in the Logstash filter stage. Extracts top-level domain components from URLs or hostnames.

Typical use cases

• Transform fields before indexing to keep schema and naming consistent.
• Prepare high-quality fields for alerts, dashboards, and downstream pipelines.

Input and output behavior

• Flow: reads a configured source field and writes parsed/transformed output into a target or root fields.
• Input field: source (default: "message").
• Output target: target (default: "tld").
• Important options: source, target.

Options

Required

• No required plugin-specific options.

Optional

• source (type: string; default: "message") — Field containing the URL or hostname to parse.
• target (type: string; default: "tld") — Parent field to nest the parsed components under (defaults to tld).

Example configuration

filter {
  tld {
    source => "[url][full]"
    target => "[url][tld]"
  }
}

Common options configuration

All Logstash filter plugins support these shared options:

• add_field (type: hash; default: {}) — Adds fields when the filter succeeds. Supports dynamic field names and values.
• add_tag (type: array; default: []) — Adds one or more tags when the filter succeeds.
• enable_metric (type: boolean; default: true) — Enables or disables metric collection for this plugin instance.
• id (type: string; default: none) — Sets an explicit plugin instance ID for monitoring and troubleshooting.
• periodic_flush (type: boolean; default: false) — Calls the filter flush method at regular intervals.
• remove_field (type: array; default: []) — Removes fields when the filter succeeds. Supports dynamic field names.
• remove_tag (type: array; default: []) — Removes tags when the filter succeeds.

filter {
  tld {
    add_field => { "pipeline_stage" => "parsed" }
    add_tag => ["parsed", "logstash_filter"]
    enable_metric => true
    id => "my_filter_instance"
    periodic_flush => false
    remove_field => ["tmp_field"]
    remove_tag => ["temporary"]
  }
}

Apply in Logit.io

1. Open your stack in Logit.io and navigate to Logstash Pipelines.
2. In the filter { ... } section, add a tld block.
3. Save your pipeline changes, then restart the Logstash pipeline if prompted.
4. Send sample events and verify parsed/enriched fields in OpenSearch Dashboards.

Validation checklist

• Confirm the tld block compiles without syntax errors.
• Verify expected new/updated fields exist in sample documents.
• Verify unexpected fields are not removed unless explicitly configured.
• Confirm tags added on success/failure align with your alerting and routing rules.

Troubleshooting

• If events are unchanged, verify your filter condition (if ...) matches incoming events.
• If the pipeline fails to start, validate braces/quotes and retry with a minimal filter block.
• If throughput drops, reduce expensive operations and test with representative sample volume.

References

• GitHub package: logstash-filter-tld (opens in a new tab)
• Canonical catalog: /log-management/ingestion-pipeline/logstash-filters-reference