struct

ECS::LogEntry::Url

Inherits JSON::Serializable < Struct < Value < Object

Constructors

new(pull : JSON::PullParser)
Source
new

Initialize all values as nil

Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Instance methods

domain(new_value : String)

A chainable setter for domain

Source
domain

url.domain

Domain of the url, such as "www.elastic.co".

In some cases a URL may refer to an IP and/or port directly, without a domain name. In this case, the IP address would go to the domain field.

Level: Extended Type: Keyword Example:

www.elastic.co
Source
domain=(domain : String | Nil)

url.domain

Domain of the url, such as "www.elastic.co".

In some cases a URL may refer to an IP and/or port directly, without a domain name. In this case, the IP address would go to the domain field.

Level: Extended Type: Keyword Example:

www.elastic.co
Source
extension(new_value : String)

A chainable setter for extension

Source
extension

url.extension

The field contains the file extension from the original request url.

The file extension is only set if it exists, as not every url has a file extension.

The leading period must not be included. For example, the value must be "png", not ".png".

Level: Extended Type: Keyword Example:

png
Source
extension=(extension : String | Nil)

url.extension

The field contains the file extension from the original request url.

The file extension is only set if it exists, as not every url has a file extension.

The leading period must not be included. For example, the value must be "png", not ".png".

Level: Extended Type: Keyword Example:

png
Source
fragment(new_value : String)

A chainable setter for fragment

Source
fragment

url.fragment

Portion of the url after the #, such as "top".

The # is not part of the fragment.

Level: Extended Type: Keyword

Source
fragment=(fragment : String | Nil)

url.fragment

Portion of the url after the #, such as "top".

The # is not part of the fragment.

Level: Extended Type: Keyword

Source
full(new_value : String)

A chainable setter for full

Source
full

url.full

If full URLs are important to your use case, they should be stored in url.full, whether this field is reconstructed or present in the event source.

Level: Extended Type: Keyword Example:

https://www.elastic.co:443/search?q=elasticsearch#top
Source
full=(full : String | Nil)

url.full

If full URLs are important to your use case, they should be stored in url.full, whether this field is reconstructed or present in the event source.

Level: Extended Type: Keyword Example:

https://www.elastic.co:443/search?q=elasticsearch#top
Source
original(new_value : String)

A chainable setter for original

Source
original

url.original

Unmodified original url as seen in the event source.

Note that in network monitoring, the observed URL may be a full URL, whereas in access logs, the URL is often just represented as a path.

This field is meant to represent the URL as it was observed, complete or not.

Level: Extended Type: Keyword Example:

https://www.elastic.co:443/search?q=elasticsearch#top or /search?q=elasticsearch
Source
original=(original : String | Nil)

url.original

Unmodified original url as seen in the event source.

Note that in network monitoring, the observed URL may be a full URL, whereas in access logs, the URL is often just represented as a path.

This field is meant to represent the URL as it was observed, complete or not.

Level: Extended Type: Keyword Example:

https://www.elastic.co:443/search?q=elasticsearch#top or /search?q=elasticsearch
Source
password(new_value : String)

A chainable setter for password

Source
password

url.password

Password of the request.

Level: Extended Type: Keyword

Source
password=(password : String | Nil)

url.password

Password of the request.

Level: Extended Type: Keyword

Source
path(new_value : String)

A chainable setter for path

Source
path

url.path

Path of the request, such as "/search".

Level: Extended Type: Keyword

Source
path=(path : String | Nil)

url.path

Path of the request, such as "/search".

Level: Extended Type: Keyword

Source
port(new_value : UInt64)

A chainable setter for port

Source
port

url.port

Port of the request, such as 443.

Level: Extended Type: Long Example:

443
Source
port=(port : UInt64 | Nil)

url.port

Port of the request, such as 443.

Level: Extended Type: Long Example:

443
Source
query(new_value : String)

A chainable setter for query

Source
query

url.query

The query field describes the query string of the request, such as "q=elasticsearch".

The ? is excluded from the query string. If a URL contains no ?, there is no query field. If there is a ? but no query, the query field exists with an empty string. The exists query can be used to differentiate between the two cases.

Level: Extended Type: Keyword

Source
query=(query : String | Nil)

url.query

The query field describes the query string of the request, such as "q=elasticsearch".

The ? is excluded from the query string. If a URL contains no ?, there is no query field. If there is a ? but no query, the query field exists with an empty string. The exists query can be used to differentiate between the two cases.

Level: Extended Type: Keyword

Source
registered_domain(new_value : String)

A chainable setter for registered_domain

Source
registered_domain

url.registered_domain

The highest registered url domain, stripped of the subdomain.

For example, the registered domain for "foo.google.com" is "google.com".

This value can be determined precisely with a list like the public suffix list (http://publicsuffix.org). Trying to approximate this by simply taking the last two labels will not work well for TLDs such as "co.uk".

Level: Extended Type: Keyword Example:

google.com
Source
registered_domain=(registered_domain : String | Nil)

url.registered_domain

The highest registered url domain, stripped of the subdomain.

For example, the registered domain for "foo.google.com" is "google.com".

This value can be determined precisely with a list like the public suffix list (http://publicsuffix.org). Trying to approximate this by simply taking the last two labels will not work well for TLDs such as "co.uk".

Level: Extended Type: Keyword Example:

google.com
Source
scheme(new_value : String)

A chainable setter for scheme

Source
scheme

url.scheme

Scheme of the request, such as "https".

Note: The : is not part of the scheme.

Level: Extended Type: Keyword Example:

https
Source
scheme=(scheme : String | Nil)

url.scheme

Scheme of the request, such as "https".

Note: The : is not part of the scheme.

Level: Extended Type: Keyword Example:

https
Source
top_level_domain(new_value : String)

A chainable setter for top_level_domain

Source
top_level_domain

url.top_level_domain

The effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name. For example, the top level domain for google.com is "com".

This value can be determined precisely with a list like the public suffix list (http://publicsuffix.org). Trying to approximate this by simply taking the last label will not work well for effective TLDs such as "co.uk".

Level: Extended Type: Keyword Example:

co.uk
Source
top_level_domain=(top_level_domain : String | Nil)

url.top_level_domain

The effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name. For example, the top level domain for google.com is "com".

This value can be determined precisely with a list like the public suffix list (http://publicsuffix.org). Trying to approximate this by simply taking the last label will not work well for effective TLDs such as "co.uk".

Level: Extended Type: Keyword Example:

co.uk
Source
username(new_value : String)

A chainable setter for username

Source
username

url.username

Username of the request.

Level: Extended Type: Keyword

Source
username=(username : String | Nil)

url.username

Username of the request.

Level: Extended Type: Keyword

Source