IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« URL decode processor User agent processor »

› › ›

URI parts processor

edit

URI parts processor

edit

Parses a Uniform Resource Identifier (URI) string and extracts its components as an object. This URI object includes properties for the URI’s domain, path, fragment, port, query, scheme, user info, username, and password.

Table 40. URI Parts Options

Name	Required	Default	Description
`field`	yes	-	Field containing the URI string.
`target_field`	no	`url`	Output field for the URI object.
`keep_original`	no	true	If `true`, the processor copies the unparsed URI to `<target_field>.original`.
`remove_if_successful`	no	false	If `true`, the processor removes the `field` after parsing the URI string. If parsing fails, the processor does not remove the `field`.
`if`	no	-	Conditionally execute this processor.
`on_failure`	no	-	Handle failures for this processor. See Handling failures in pipelines.
`ignore_failure`	no	`false`	Ignore failures for this processor. See Handling failures in pipelines.
`tag`	no	-	An identifier for this processor. Useful for debugging and metrics.

Here is an example definition of the URI parts processor:

{
  "description" : "...",
  "processors" : [
    {
      "uri_parts": {
        "field": "input_field",
        "target_field": "url",
        "keep_original": true,
        "remove_if_successful": false
      }
    }
  ]
}

When the above processor executes on the following document:

{
  "_source": {
    "input_field": "http://myusername:[email protected]:80/foo.gif?key1=val1&key2=val2#fragment"
  }
}

It produces this result:

"_source" : {
  "input_field" : "http://myusername:[email protected]:80/foo.gif?key1=val1&key2=val2#fragment",
  "url" : {
    "path" : "/foo.gif",
    "fragment" : "fragment",
    "extension" : "gif",
    "password" : "mypassword",
    "original" : "http://myusername:[email protected]:80/foo.gif?key1=val1&key2=val2#fragment",
    "scheme" : "http",
    "port" : 80,
    "user_info" : "myusername:mypassword",
    "domain" : "www.example.com",
    "query" : "key1=val1&key2=val2",
    "username" : "myusername"
  }
}

« URL decode processor User agent processor »