Registered domain processor
editRegistered domain processor
editExtracts the registered domain (also known as the effective top-level domain or eTLD), sub-domain, and top-level domain from a fully qualified domain name (FQDN). Uses the registered domains defined in the Mozilla Public Suffix List.
Table 35. Registered Domain Options
Name | Required | Default | Description |
---|---|---|---|
|
yes |
Field containing the source FQDN. |
|
|
no |
|
Object field containing
extracted domain components. If an |
|
no |
|
If |
|
no |
- |
Description of the processor. Useful for describing the purpose of the processor or its configuration. |
|
no |
- |
Conditionally execute the processor. See Conditionally run a processor. |
|
no |
|
Ignore failures for the processor. See Handling pipeline failures. |
|
no |
- |
Handle failures for the processor. See Handling pipeline failures. |
|
no |
- |
Identifier for the processor. Useful for debugging and metrics. |
Examples
editThe following example illustrates the use of the registered domain processor:
response = client.ingest.simulate( body: { pipeline: { processors: [ { registered_domain: { field: 'fqdn', target_field: 'url' } } ] }, docs: [ { _source: { fqdn: 'www.example.ac.uk' } } ] } ) puts response
POST _ingest/pipeline/_simulate { "pipeline": { "processors": [ { "registered_domain": { "field": "fqdn", "target_field": "url" } } ] }, "docs": [ { "_source": { "fqdn": "www.example.ac.uk" } } ] }
Which produces the following result:
{ "docs": [ { "doc": { ... "_source": { "fqdn": "www.example.ac.uk", "url": { "subdomain": "www", "registered_domain": "example.ac.uk", "top_level_domain": "ac.uk", "domain": "www.example.ac.uk" } } } } ] }