html/server/7.7/exported-fields-ecs.html

<!DOCTYPE html>
<html lang="en-us">
  <head>
    
<meta charset="UTF-8">
<title>ECS fields | APM Server Reference [7.7] | Elastic</title>
<meta class="elastic" name="content" content="ECS fields | APM Server Reference [7.7]">

<link rel="home" href="index.html" title="APM Server Reference [7.7]"/>
<link rel="up" href="exported-fields.html" title="Exported fields"/>
<link rel="prev" href="exported-fields-docker-processor.html" title="Docker fields"/>
<link rel="next" href="exported-fields-host-processor.html" title="Host fields"/>
<meta class="elastic" name="product_version" content="7.7"/>
<meta class="elastic" name="product_name" content="APM"/>
<meta class="elastic" name="website_area" content="documentation"/>
<meta name="DC.type" content="Learn/Docs/APM Server/Reference/7.7"/>
<meta name="DC.subject" content="APM"/>
<meta name="DC.identifier" content="7.7"/>
<meta name="robots" content="noindex,nofollow"/>

    <meta http-equiv="content-type" content="text/html; charset=utf-8" />
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <script src="https://cdn.optimizely.com/js/18132920325.js"></script>
    <link rel="apple-touch-icon" sizes="57x57" href="/apple-icon-57x57.png">
    <link rel="apple-touch-icon" sizes="60x60" href="/apple-icon-60x60.png">
    <link rel="apple-touch-icon" sizes="72x72" href="/apple-icon-72x72.png">
    <link rel="apple-touch-icon" sizes="76x76" href="/apple-icon-76x76.png">
    <link rel="apple-touch-icon" sizes="114x114" href="/apple-icon-114x114.png">
    <link rel="apple-touch-icon" sizes="120x120" href="/apple-icon-120x120.png">
    <link rel="apple-touch-icon" sizes="144x144" href="/apple-icon-144x144.png">
    <link rel="apple-touch-icon" sizes="152x152" href="/apple-icon-152x152.png">
    <link rel="apple-touch-icon" sizes="180x180" href="/apple-icon-180x180.png">
    <link rel="icon" type="image/png" href="/favicon-32x32.png" sizes="32x32">
    <link rel="icon" type="image/png" href="/android-chrome-192x192.png" sizes="192x192">
    <link rel="icon" type="image/png" href="/favicon-96x96.png" sizes="96x96">
    <link rel="icon" type="image/png" href="/favicon-16x16.png" sizes="16x16">
    <link rel="manifest" href="/manifest.json">
    <meta name="apple-mobile-web-app-title" content="Elastic">
    <meta name="application-name" content="Elastic">
    <meta name="msapplication-TileColor" content="#ffffff">
    <meta name="msapplication-TileImage" content="/mstile-144x144.png">
    <meta name="theme-color" content="#ffffff">
    <meta name="naver-site-verification" content="936882c1853b701b3cef3721758d80535413dbfd" />
    <meta name="yandex-verification" content="d8a47e95d0972434" />
    <meta name="localized" content="true" />
    <meta name="st:robots" content="follow,index" />
    <meta property="og:image" content="https://static-www.elastic.co/v3/assets/bltefdd0b53724fa2ce/blt280217a63b82a734/6202d3378b1f312528798412/elastic-logo.svg" />
    <meta property="og:image:width" content="500" />
    <meta property="og:image:height" content="172" />
    <link rel="shortcut icon" href="/favicon.ico" type="image/x-icon">
    <link rel="icon" href="/favicon.ico" type="image/x-icon">
    <link rel="apple-touch-icon-precomposed" sizes="64x64" href="/favicon_64x64_16bit.png">
    <link rel="apple-touch-icon-precomposed" sizes="32x32" href="/favicon_32x32.png">
    <link rel="apple-touch-icon-precomposed" sizes="16x16" href="/favicon_16x16.png">
    <!-- Give IE8 a fighting chance -->
    <!--[if lt IE 9]>
    <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
    <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
    <![endif]-->
    <link rel="stylesheet" type="text/css" href="/guide/static/styles-v1.css" />
  </head>

  <!--© 2015-2025 Elasticsearch B.V. -->
  <!-- All Elastic documentation is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License. -->
  <!-- http://creativecommons.org/licenses/by-nc-nd/4.0/ -->

  <body>
    <!-- Google Tag Manager -->
    <script>dataLayer = [];</script><noscript><iframe src="//www.googletagmanager.com/ns.html?id=GTM-58RLH5" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
    <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= '//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); })(window,document,'script','dataLayer','GTM-58RLH5');</script>
    <!-- End Google Tag Manager -->

    <!-- Global site tag (gtag.js) - Google Analytics -->
    <script async src="https://www.googletagmanager.com/gtag/js?id=UA-12395217-16"></script>
    <script>
      window.dataLayer = window.dataLayer || [];
      function gtag(){dataLayer.push(arguments);}
      gtag('js', new Date());
      gtag('config', 'UA-12395217-16');
    </script>

    <!-- Google Tag Manager for GA4 -->
    <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src='https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);})(window,document,'script','dataLayer','GTM-KNJMG2M');</script>
    <noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-KNJMG2M" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
    <!-- End Google Tag Manager for GA4-->

    <div id='elastic-nav' style="display:none;"></div>
    <script src='https://www.elastic.co/elastic-nav.js'></script>

    <div class="main-container">
      <section id="content" >
        <div class="content-wrapper">

          <section id="guide" lang="en">
            <div class="container-fluid">
              <div class="row pb-3">
                <div class="col-12 order-2 col-md-4 order-md-1 col-lg-3 h-almost-full-md sticky-top-md" id="left_col">
                  <!-- The TOC is appended here -->
                </div>

                <div class="col-12 order-1 col-md-8 order-md-2 col-lg-7 order-lg-2 guide-section" id="middle_col">
                  <!-- start body -->
                  
<div class="page_header">
A newer version is available. For the latest information, see the
<a href="../current/index.html">current release documentation</a>.
</div>
<div class="navheader">
<span class="prev">
<a href="exported-fields-docker-processor.html">« Docker fields</a>
</span>
<span class="next">
<a href="exported-fields-host-processor.html">Host fields »</a>
</span>
</div>
<div class="book" lang="en">
<div class="titlepage">
<div class="breadcrumbs">
<span class="breadcrumb-link"><a href="/guide/">Elastic Docs</a></span>
<span class="chevron-right">›</span><span class="breadcrumb-link">
  <div id="related-products" class="dropdown">
  <div class="related-products-title">APM:</div>
  <div class="dropdown-anchor" tabindex="0">Server Reference<span class="dropdown-icon"></span></div>
  <div class="dropdown-content">
  <ul>
  <li class="dropdown-category">APM</li>
  <ul>
  <li><a href="/guide/en/observability/current/apm.html">Observability › APM</a></li>
  </ul>
  <li class="dropdown-category">APM agents</li>
  <ul>
  <li><a href="/guide/en/apm/agent/android/current/intro.html">Android Agent Reference</a></li>
  <li><a href="/guide/en/apm/agent/go/current/introduction.html">Go Agent Reference</a></li>
  <li><a href="/guide/en/apm/agent/swift/current/intro.html">iOS Agent Reference</a></li>
  <li><a href="/guide/en/apm/agent/java/current/intro.html">Java Agent Reference</a></li>
  <li><a href="/guide/en/apm/agent/dotnet/current/intro.html">.NET Agent Reference</a></li>
  <li><a href="/guide/en/apm/agent/nodejs/current/intro.html">Node.js Agent Reference</a></li>
  <li><a href="/guide/en/apm/agent/php/current/intro.html">PHP Agent Reference</a></li>
  <li><a href="/guide/en/apm/agent/python/current/getting-started.html">Python Agent Reference</a></li>
  <li><a href="/guide/en/apm/agent/ruby/current/introduction.html">Ruby Agent Reference</a></li>
  <li><a href="/guide/en/apm/agent/rum-js/current/intro.html">Real User Monitoring JavaScript Agent Reference</a></li>
  </ul>
  <li class="dropdown-category">APM extensions</li>
  <ul>
  <li><a href="/guide/en/apm/lambda/current/aws-lambda-arch.html">AWS Lambda extension</a></li>
  <li><a href="/guide/en/apm/attacher/current/apm-attacher.html">Attacher</a></li>
  </ul>
  </ul>
  </div>
  </div>
<span class="chevron-right">›</span><span class="breadcrumb-link"><a href="exported-fields.html">Exported fields</a></span>
</div>
<div>
<div><h1 class="title"><a id="id-1"></a>ECS fields</h1><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.7/docs/fields.asciidoc">edit</a></div>
</div>
<!--EXTRA-->
</div>
<div id="content">
<div id="url-to-v3" class="version-warning">
    <strong>IMPORTANT</strong>: This documentation is no longer updated. Refer to <a href="https://www.elastic.co/support/eol">Elastic's version policy</a> and the <a href="https://www.elastic.co/docs">latest documentation</a>.
</div>
<div class="chapter">
<div class="titlepage"><div><div>
<div class="position-relative"><h2 class="title"><a id="exported-fields-ecs"></a>ECS fields</h2><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.7/docs/fields.asciidoc">edit</a></div>
</div></div></div>
<p>ECS Fields.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">@timestamp</code></strong></span>
</span>
</dt>
<dd>
<p>Date/time when the event originated.
This is the date/time extracted from the event, typically representing when the event was generated by the source.
If the event source has no original timestamp, this value is typically populated by the first time the event was received by the pipeline.
Required field for all events.</p>
<p>type: date</p>
<p>example: 2016-05-23T08:05:34.853Z</p>
<p>required: True</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">labels</code></strong></span>
</span>
</dt>
<dd>
<p>Custom key/value pairs.
Can be used to add meta information to events. Should not contain nested objects. All values are stored as keyword.
Example: <code class="literal">docker</code> and <code class="literal">k8s</code> labels.</p>
<p>type: object</p>
<p>example: {"application": "foo-bar", "env": "production"}</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">message</code></strong></span>
</span>
</dt>
<dd>
<p>For log events the message field contains the log message, optimized for viewing in a log viewer.
For structured logs without an original message field, other fields can be concatenated to form a human-readable summary of the event.
If multiple messages exist, they can be combined into one message.</p>
<p>type: text</p>
<p>example: Hello World</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">tags</code></strong></span>
</span>
</dt>
<dd>
<p>List of keywords used to tag each event.</p>
<p>type: keyword</p>
<p>example: ["production", "env2"]</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_agent"></a>agent</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.7/docs/fields.asciidoc">edit</a></div>
<p>The agent fields contain the data about the software entity, if any, that collects, detects, or observes events on a host, or takes measurements on a host.
Examples include Beats. Agents may also run on observers. ECS agent.* fields shall be populated with details of the agent running on the host or observer where the event happened or the measurement was taken.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">agent.ephemeral_id</code></strong></span>
</span>
</dt>
<dd>
<p>Ephemeral identifier of this agent (if one exists).
This id normally changes across restarts, but <code class="literal">agent.id</code> does not.</p>
<p>type: keyword</p>
<p>example: 8a4f500f</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">agent.id</code></strong></span>
</span>
</dt>
<dd>
<p>Unique identifier of this agent (if one exists).
Example: For Beats this would be beat.id.</p>
<p>type: keyword</p>
<p>example: 8a4f500d</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">agent.name</code></strong></span>
</span>
</dt>
<dd>
<p>Custom name of the agent.
This is a name that can be given to an agent. This can be helpful if for example two Filebeat instances are running on the same host but a human readable separation is needed on which Filebeat instance data is coming from.
If no name is given, the name is often left empty.</p>
<p>type: keyword</p>
<p>example: foo</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">agent.type</code></strong></span>
</span>
</dt>
<dd>
<p>Type of the agent.
The agent type stays always the same and should be given by the agent used. In case of Filebeat the agent would always be Filebeat also if two Filebeat instances are run on the same machine.</p>
<p>type: keyword</p>
<p>example: filebeat</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">agent.version</code></strong></span>
</span>
</dt>
<dd>
<p>Version of the agent.</p>
<p>type: keyword</p>
<p>example: 6.0.0-rc2</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_as"></a>as</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.7/docs/fields.asciidoc">edit</a></div>
<p>An autonomous system (AS) is a collection of connected Internet Protocol (IP) routing prefixes under the control of one or more network operators on behalf of a single administrative entity or domain that presents a common, clearly defined routing policy to the internet.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">as.number</code></strong></span>
</span>
</dt>
<dd>
<p>Unique number allocated to the autonomous system. The autonomous system number (ASN) uniquely identifies each network on the Internet.</p>
<p>type: long</p>
<p>example: 15169</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">as.organization.name</code></strong></span>
</span>
</dt>
<dd>
<p>Organization name.</p>
<p>type: keyword</p>
<p>example: Google LLC</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">as.organization.name.text</code></strong></span>
</span>
</dt>
<dd>
<p>type: text</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_client"></a>client</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.7/docs/fields.asciidoc">edit</a></div>
<p>A client is defined as the initiator of a network connection for events regarding sessions, connections, or bidirectional flow records.
For TCP events, the client is the initiator of the TCP connection that sends the SYN packet(s). For other protocols, the client is generally the initiator or requestor in the network transaction. Some systems use the term "originator" to refer the client in TCP connections. The client fields describe details about the system acting as the client in the network event. Client fields are usually populated in conjunction with server fields. Client fields are generally not populated for packet-level events.
Client / server representations can add semantic context to an exchange, which is helpful to visualize the data in certain situations. If your context falls in that category, you should still ensure that source and destination are filled appropriately.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.address</code></strong></span>
</span>
</dt>
<dd>
<p>Some event client addresses are defined ambiguously. The event will sometimes list an IP, a domain or a unix socket.  You should always store the raw address in the <code class="literal">.address</code> field.
Then it should be duplicated to <code class="literal">.ip</code> or <code class="literal">.domain</code>, depending on which one it is.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.as.number</code></strong></span>
</span>
</dt>
<dd>
<p>Unique number allocated to the autonomous system. The autonomous system number (ASN) uniquely identifies each network on the Internet.</p>
<p>type: long</p>
<p>example: 15169</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.as.organization.name</code></strong></span>
</span>
</dt>
<dd>
<p>Organization name.</p>
<p>type: keyword</p>
<p>example: Google LLC</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.as.organization.name.text</code></strong></span>
</span>
</dt>
<dd>
<p>type: text</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.bytes</code></strong></span>
</span>
</dt>
<dd>
<p>Bytes sent from the client to the server.</p>
<p>type: long</p>
<p>example: 184</p>
<p>format: bytes</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.domain</code></strong></span>
</span>
</dt>
<dd>
<p>Client domain.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.geo.city_name</code></strong></span>
</span>
</dt>
<dd>
<p>City name.</p>
<p>type: keyword</p>
<p>example: Montreal</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.geo.continent_name</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the continent.</p>
<p>type: keyword</p>
<p>example: North America</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.geo.country_iso_code</code></strong></span>
</span>
</dt>
<dd>
<p>Country ISO code.</p>
<p>type: keyword</p>
<p>example: CA</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.geo.country_name</code></strong></span>
</span>
</dt>
<dd>
<p>Country name.</p>
<p>type: keyword</p>
<p>example: Canada</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.geo.location</code></strong></span>
</span>
</dt>
<dd>
<p>Longitude and latitude.</p>
<p>type: geo_point</p>
<p>example: { "lon": -73.614830, "lat": 45.505918 }</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.geo.name</code></strong></span>
</span>
</dt>
<dd>
<p>User-defined description of a location, at the level of granularity they care about.
Could be the name of their data centers, the floor number, if this describes a local physical entity, city names.
Not typically used in automated geolocation.</p>
<p>type: keyword</p>
<p>example: boston-dc</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.geo.region_iso_code</code></strong></span>
</span>
</dt>
<dd>
<p>Region ISO code.</p>
<p>type: keyword</p>
<p>example: CA-QC</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.geo.region_name</code></strong></span>
</span>
</dt>
<dd>
<p>Region name.</p>
<p>type: keyword</p>
<p>example: Quebec</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.ip</code></strong></span>
</span>
</dt>
<dd>
<p>IP address of the client.
Can be one or multiple IPv4 or IPv6 addresses.</p>
<p>type: ip</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.mac</code></strong></span>
</span>
</dt>
<dd>
<p>MAC address of the client.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.nat.ip</code></strong></span>
</span>
</dt>
<dd>
<p>Translated IP of source based NAT sessions (e.g. internal client to internet).
Typically connections traversing load balancers, firewalls, or routers.</p>
<p>type: ip</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.nat.port</code></strong></span>
</span>
</dt>
<dd>
<p>Translated port of source based NAT sessions (e.g. internal client to internet).
Typically connections traversing load balancers, firewalls, or routers.</p>
<p>type: long</p>
<p>format: string</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.packets</code></strong></span>
</span>
</dt>
<dd>
<p>Packets sent from the client to the server.</p>
<p>type: long</p>
<p>example: 12</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.port</code></strong></span>
</span>
</dt>
<dd>
<p>Port of the client.</p>
<p>type: long</p>
<p>format: string</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.registered_domain</code></strong></span>
</span>
</dt>
<dd>
<p>The highest registered client 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 (<a href="http://publicsuffix.org" class="ulink" target="_top">http://publicsuffix.org</a>). Trying to approximate this by simply taking the last two labels will not work well for TLDs such as "co.uk".</p>
<p>type: keyword</p>
<p>example: google.com</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.top_level_domain</code></strong></span>
</span>
</dt>
<dd>
<p>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 (<a href="http://publicsuffix.org" class="ulink" target="_top">http://publicsuffix.org</a>). Trying to approximate this by simply taking the last label will not work well for effective TLDs such as "co.uk".</p>
<p>type: keyword</p>
<p>example: co.uk</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.user.domain</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the directory the user is a member of.
For example, an LDAP or Active Directory domain name.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.user.email</code></strong></span>
</span>
</dt>
<dd>
<p>User email address.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.user.full_name</code></strong></span>
</span>
</dt>
<dd>
<p>User&#8217;s full name, if available.</p>
<p>type: keyword</p>
<p>example: Albert Einstein</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.user.full_name.text</code></strong></span>
</span>
</dt>
<dd>
<p>type: text</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.user.group.domain</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the directory the group is a member of.
For example, an LDAP or Active Directory domain name.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.user.group.id</code></strong></span>
</span>
</dt>
<dd>
<p>Unique identifier for the group on the system/platform.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.user.group.name</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the group.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.user.hash</code></strong></span>
</span>
</dt>
<dd>
<p>Unique user hash to correlate information for a user in anonymized form.
Useful if <code class="literal">user.id</code> or <code class="literal">user.name</code> contain confidential information and cannot be used.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.user.id</code></strong></span>
</span>
</dt>
<dd>
<p>Unique identifiers of the user.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.user.name</code></strong></span>
</span>
</dt>
<dd>
<p>Short name or login of the user.</p>
<p>type: keyword</p>
<p>example: albert</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">client.user.name.text</code></strong></span>
</span>
</dt>
<dd>
<p>type: text</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_cloud"></a>cloud</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.7/docs/fields.asciidoc">edit</a></div>
<p>Fields related to the cloud or infrastructure the events are coming from.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">cloud.account.id</code></strong></span>
</span>
</dt>
<dd>
<p>The cloud account or organization id used to identify different entities in a multi-tenant environment.
Examples: AWS account id, Google Cloud ORG Id, or other unique identifier.</p>
<p>type: keyword</p>
<p>example: 666777888999</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">cloud.availability_zone</code></strong></span>
</span>
</dt>
<dd>
<p>Availability zone in which this host is running.</p>
<p>type: keyword</p>
<p>example: us-east-1c</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">cloud.instance.id</code></strong></span>
</span>
</dt>
<dd>
<p>Instance ID of the host machine.</p>
<p>type: keyword</p>
<p>example: i-1234567890abcdef0</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">cloud.instance.name</code></strong></span>
</span>
</dt>
<dd>
<p>Instance name of the host machine.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">cloud.machine.type</code></strong></span>
</span>
</dt>
<dd>
<p>Machine type of the host machine.</p>
<p>type: keyword</p>
<p>example: t2.medium</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">cloud.provider</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the cloud provider. Example values are aws, azure, gcp, or digitalocean.</p>
<p>type: keyword</p>
<p>example: aws</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">cloud.region</code></strong></span>
</span>
</dt>
<dd>
<p>Region in which this host is running.</p>
<p>type: keyword</p>
<p>example: us-east-1</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_code_signature"></a>code_signature</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.7/docs/fields.asciidoc">edit</a></div>
<p>These fields contain information about binary code signatures.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">code_signature.exists</code></strong></span>
</span>
</dt>
<dd>
<p>Boolean to capture if a signature is present.</p>
<p>type: boolean</p>
<p>example: true</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">code_signature.status</code></strong></span>
</span>
</dt>
<dd>
<p>Additional information about the certificate status.
This is useful for logging cryptographic errors with the certificate validity or trust status. Leave unpopulated if the validity or trust of the certificate was unchecked.</p>
<p>type: keyword</p>
<p>example: ERROR_UNTRUSTED_ROOT</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">code_signature.subject_name</code></strong></span>
</span>
</dt>
<dd>
<p>Subject name of the code signer</p>
<p>type: keyword</p>
<p>example: Microsoft Corporation</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">code_signature.trusted</code></strong></span>
</span>
</dt>
<dd>
<p>Stores the trust status of the certificate chain.
Validating the trust of the certificate chain may be complicated, and this field should only be populated by tools that actively check the status.</p>
<p>type: boolean</p>
<p>example: true</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">code_signature.valid</code></strong></span>
</span>
</dt>
<dd>
<p>Boolean to capture if the digital signature is verified against the binary content.
Leave unpopulated if a certificate was unchecked.</p>
<p>type: boolean</p>
<p>example: true</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_container_2"></a>container</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.7/docs/fields.asciidoc">edit</a></div>
<p>Container fields are used for meta information about the specific container that is the source of information.
These fields help correlate data based containers from any runtime.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">container.id</code></strong></span>
</span>
</dt>
<dd>
<p>Unique container id.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">container.image.name</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the image the container was built on.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">container.image.tag</code></strong></span>
</span>
</dt>
<dd>
<p>Container image tags.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">container.labels</code></strong></span>
</span>
</dt>
<dd>
<p>Image labels.</p>
<p>type: object</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">container.name</code></strong></span>
</span>
</dt>
<dd>
<p>Container name.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">container.runtime</code></strong></span>
</span>
</dt>
<dd>
<p>Runtime managing this container.</p>
<p>type: keyword</p>
<p>example: docker</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_destination_2"></a>destination</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.7/docs/fields.asciidoc">edit</a></div>
<p>Destination fields describe details about the destination of a packet/event.
Destination fields are usually populated in conjunction with source fields.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.address</code></strong></span>
</span>
</dt>
<dd>
<p>Some event destination addresses are defined ambiguously. The event will sometimes list an IP, a domain or a unix socket.  You should always store the raw address in the <code class="literal">.address</code> field.
Then it should be duplicated to <code class="literal">.ip</code> or <code class="literal">.domain</code>, depending on which one it is.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.as.number</code></strong></span>
</span>
</dt>
<dd>
<p>Unique number allocated to the autonomous system. The autonomous system number (ASN) uniquely identifies each network on the Internet.</p>
<p>type: long</p>
<p>example: 15169</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.as.organization.name</code></strong></span>
</span>
</dt>
<dd>
<p>Organization name.</p>
<p>type: keyword</p>
<p>example: Google LLC</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.as.organization.name.text</code></strong></span>
</span>
</dt>
<dd>
<p>type: text</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.bytes</code></strong></span>
</span>
</dt>
<dd>
<p>Bytes sent from the destination to the source.</p>
<p>type: long</p>
<p>example: 184</p>
<p>format: bytes</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.domain</code></strong></span>
</span>
</dt>
<dd>
<p>Destination domain.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.geo.city_name</code></strong></span>
</span>
</dt>
<dd>
<p>City name.</p>
<p>type: keyword</p>
<p>example: Montreal</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.geo.continent_name</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the continent.</p>
<p>type: keyword</p>
<p>example: North America</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.geo.country_iso_code</code></strong></span>
</span>
</dt>
<dd>
<p>Country ISO code.</p>
<p>type: keyword</p>
<p>example: CA</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.geo.country_name</code></strong></span>
</span>
</dt>
<dd>
<p>Country name.</p>
<p>type: keyword</p>
<p>example: Canada</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.geo.location</code></strong></span>
</span>
</dt>
<dd>
<p>Longitude and latitude.</p>
<p>type: geo_point</p>
<p>example: { "lon": -73.614830, "lat": 45.505918 }</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.geo.name</code></strong></span>
</span>
</dt>
<dd>
<p>User-defined description of a location, at the level of granularity they care about.
Could be the name of their data centers, the floor number, if this describes a local physical entity, city names.
Not typically used in automated geolocation.</p>
<p>type: keyword</p>
<p>example: boston-dc</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.geo.region_iso_code</code></strong></span>
</span>
</dt>
<dd>
<p>Region ISO code.</p>
<p>type: keyword</p>
<p>example: CA-QC</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.geo.region_name</code></strong></span>
</span>
</dt>
<dd>
<p>Region name.</p>
<p>type: keyword</p>
<p>example: Quebec</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.ip</code></strong></span>
</span>
</dt>
<dd>
<p>IP address of the destination.
Can be one or multiple IPv4 or IPv6 addresses.</p>
<p>type: ip</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.mac</code></strong></span>
</span>
</dt>
<dd>
<p>MAC address of the destination.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.nat.ip</code></strong></span>
</span>
</dt>
<dd>
<p>Translated ip of destination based NAT sessions (e.g. internet to private DMZ)
Typically used with load balancers, firewalls, or routers.</p>
<p>type: ip</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.nat.port</code></strong></span>
</span>
</dt>
<dd>
<p>Port the source session is translated to by NAT Device.
Typically used with load balancers, firewalls, or routers.</p>
<p>type: long</p>
<p>format: string</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.packets</code></strong></span>
</span>
</dt>
<dd>
<p>Packets sent from the destination to the source.</p>
<p>type: long</p>
<p>example: 12</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.port</code></strong></span>
</span>
</dt>
<dd>
<p>Port of the destination.</p>
<p>type: long</p>
<p>format: string</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.registered_domain</code></strong></span>
</span>
</dt>
<dd>
<p>The highest registered destination 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 (<a href="http://publicsuffix.org" class="ulink" target="_top">http://publicsuffix.org</a>). Trying to approximate this by simply taking the last two labels will not work well for TLDs such as "co.uk".</p>
<p>type: keyword</p>
<p>example: google.com</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.top_level_domain</code></strong></span>
</span>
</dt>
<dd>
<p>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 (<a href="http://publicsuffix.org" class="ulink" target="_top">http://publicsuffix.org</a>). Trying to approximate this by simply taking the last label will not work well for effective TLDs such as "co.uk".</p>
<p>type: keyword</p>
<p>example: co.uk</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.user.domain</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the directory the user is a member of.
For example, an LDAP or Active Directory domain name.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.user.email</code></strong></span>
</span>
</dt>
<dd>
<p>User email address.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.user.full_name</code></strong></span>
</span>
</dt>
<dd>
<p>User&#8217;s full name, if available.</p>
<p>type: keyword</p>
<p>example: Albert Einstein</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.user.full_name.text</code></strong></span>
</span>
</dt>
<dd>
<p>type: text</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.user.group.domain</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the directory the group is a member of.
For example, an LDAP or Active Directory domain name.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.user.group.id</code></strong></span>
</span>
</dt>
<dd>
<p>Unique identifier for the group on the system/platform.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.user.group.name</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the group.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.user.hash</code></strong></span>
</span>
</dt>
<dd>
<p>Unique user hash to correlate information for a user in anonymized form.
Useful if <code class="literal">user.id</code> or <code class="literal">user.name</code> contain confidential information and cannot be used.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.user.id</code></strong></span>
</span>
</dt>
<dd>
<p>Unique identifiers of the user.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.user.name</code></strong></span>
</span>
</dt>
<dd>
<p>Short name or login of the user.</p>
<p>type: keyword</p>
<p>example: albert</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">destination.user.name.text</code></strong></span>
</span>
</dt>
<dd>
<p>type: text</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_dll"></a>dll</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.7/docs/fields.asciidoc">edit</a></div>
<p>These fields contain information about code libraries dynamically loaded into processes.</p>
<p>Many operating systems refer to "shared code libraries" with different names, but this field set refers to all of the following:
* Dynamic-link library (<code class="literal">.dll</code>) commonly used on Windows
* Shared Object (<code class="literal">.so</code>) commonly used on Unix-like operating systems
* Dynamic library (<code class="literal">.dylib</code>) commonly used on macOS</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">dll.code_signature.exists</code></strong></span>
</span>
</dt>
<dd>
<p>Boolean to capture if a signature is present.</p>
<p>type: boolean</p>
<p>example: true</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">dll.code_signature.status</code></strong></span>
</span>
</dt>
<dd>
<p>Additional information about the certificate status.
This is useful for logging cryptographic errors with the certificate validity or trust status. Leave unpopulated if the validity or trust of the certificate was unchecked.</p>
<p>type: keyword</p>
<p>example: ERROR_UNTRUSTED_ROOT</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">dll.code_signature.subject_name</code></strong></span>
</span>
</dt>
<dd>
<p>Subject name of the code signer</p>
<p>type: keyword</p>
<p>example: Microsoft Corporation</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">dll.code_signature.trusted</code></strong></span>
</span>
</dt>
<dd>
<p>Stores the trust status of the certificate chain.
Validating the trust of the certificate chain may be complicated, and this field should only be populated by tools that actively check the status.</p>
<p>type: boolean</p>
<p>example: true</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">dll.code_signature.valid</code></strong></span>
</span>
</dt>
<dd>
<p>Boolean to capture if the digital signature is verified against the binary content.
Leave unpopulated if a certificate was unchecked.</p>
<p>type: boolean</p>
<p>example: true</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">dll.hash.md5</code></strong></span>
</span>
</dt>
<dd>
<p>MD5 hash.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">dll.hash.sha1</code></strong></span>
</span>
</dt>
<dd>
<p>SHA1 hash.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">dll.hash.sha256</code></strong></span>
</span>
</dt>
<dd>
<p>SHA256 hash.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">dll.hash.sha512</code></strong></span>
</span>
</dt>
<dd>
<p>SHA512 hash.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">dll.name</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the library.
This generally maps to the name of the file on disk.</p>
<p>type: keyword</p>
<p>example: kernel32.dll</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">dll.path</code></strong></span>
</span>
</dt>
<dd>
<p>Full file path of the library.</p>
<p>type: keyword</p>
<p>example: C:\Windows\System32\kernel32.dll</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">dll.pe.company</code></strong></span>
</span>
</dt>
<dd>
<p>Internal company name of the file, provided at compile-time.</p>
<p>type: keyword</p>
<p>example: Microsoft Corporation</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">dll.pe.description</code></strong></span>
</span>
</dt>
<dd>
<p>Internal description of the file, provided at compile-time.</p>
<p>type: keyword</p>
<p>example: Paint</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">dll.pe.file_version</code></strong></span>
</span>
</dt>
<dd>
<p>Internal version of the file, provided at compile-time.</p>
<p>type: keyword</p>
<p>example: 6.3.9600.17415</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">dll.pe.original_file_name</code></strong></span>
</span>
</dt>
<dd>
<p>Internal name of the file, provided at compile-time.</p>
<p>type: keyword</p>
<p>example: MSPAINT.EXE</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">dll.pe.product</code></strong></span>
</span>
</dt>
<dd>
<p>Internal product name of the file, provided at compile-time.</p>
<p>type: keyword</p>
<p>example: Microsoft® Windows® Operating System</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_dns"></a>dns</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.7/docs/fields.asciidoc">edit</a></div>
<p>Fields describing DNS queries and answers.
DNS events should either represent a single DNS query prior to getting answers (<code class="literal">dns.type:query</code>) or they should represent a full exchange and contain the query details as well as all of the answers that were provided for this query (<code class="literal">dns.type:answer</code>).</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">dns.answers</code></strong></span>
</span>
</dt>
<dd>
<p>An array containing an object for each answer section returned by the server.
The main keys that should be present in these objects are defined by ECS. Records that have more information may contain more keys than what ECS defines.
Not all DNS data sources give all details about DNS answers. At minimum, answer objects must contain the <code class="literal">data</code> key. If more information is available, map as much of it to ECS as possible, and add any additional fields to the answer objects as custom fields.</p>
<p>type: object</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">dns.answers.class</code></strong></span>
</span>
</dt>
<dd>
<p>The class of DNS data contained in this resource record.</p>
<p>type: keyword</p>
<p>example: IN</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">dns.answers.data</code></strong></span>
</span>
</dt>
<dd>
<p>The data describing the resource.
The meaning of this data depends on the type and class of the resource record.</p>
<p>type: keyword</p>
<p>example: 10.10.10.10</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">dns.answers.name</code></strong></span>
</span>
</dt>
<dd>
<p>The domain name to which this resource record pertains.
If a chain of CNAME is being resolved, each answer&#8217;s <code class="literal">name</code> should be the one that corresponds with the answer&#8217;s <code class="literal">data</code>. It should not simply be the original <code class="literal">question.name</code> repeated.</p>
<p>type: keyword</p>
<p>example: www.google.com</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">dns.answers.ttl</code></strong></span>
</span>
</dt>
<dd>
<p>The time interval in seconds that this resource record may be cached before it should be discarded. Zero values mean that the data should not be cached.</p>
<p>type: long</p>
<p>example: 180</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">dns.answers.type</code></strong></span>
</span>
</dt>
<dd>
<p>The type of data contained in this resource record.</p>
<p>type: keyword</p>
<p>example: CNAME</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">dns.header_flags</code></strong></span>
</span>
</dt>
<dd>
<p>Array of 2 letter DNS header flags.
Expected values are: AA, TC, RD, RA, AD, CD, DO.</p>
<p>type: keyword</p>
<p>example: [<em>RD</em>, <em>RA</em>]</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">dns.id</code></strong></span>
</span>
</dt>
<dd>
<p>The DNS packet identifier assigned by the program that generated the query. The identifier is copied to the response.</p>
<p>type: keyword</p>
<p>example: 62111</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">dns.op_code</code></strong></span>
</span>
</dt>
<dd>
<p>The DNS operation code that specifies the kind of query in the message. This value is set by the originator of a query and copied into the response.</p>
<p>type: keyword</p>
<p>example: QUERY</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">dns.question.class</code></strong></span>
</span>
</dt>
<dd>
<p>The class of records being queried.</p>
<p>type: keyword</p>
<p>example: IN</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">dns.question.name</code></strong></span>
</span>
</dt>
<dd>
<p>The name being queried.
If the name field contains non-printable characters (below 32 or above 126), those characters should be represented as escaped base 10 integers (\DDD). Back slashes and quotes should be escaped. Tabs, carriage returns, and line feeds should be converted to \t, \r, and \n respectively.</p>
<p>type: keyword</p>
<p>example: www.google.com</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">dns.question.registered_domain</code></strong></span>
</span>
</dt>
<dd>
<p>The highest registered 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 (<a href="http://publicsuffix.org" class="ulink" target="_top">http://publicsuffix.org</a>). Trying to approximate this by simply taking the last two labels will not work well for TLDs such as "co.uk".</p>
<p>type: keyword</p>
<p>example: google.com</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">dns.question.subdomain</code></strong></span>
</span>
</dt>
<dd>
<p>The subdomain is all of the labels under the registered_domain.
If the domain has multiple levels of subdomain, such as "sub2.sub1.example.com", the subdomain field should contain "sub2.sub1", with no trailing period.</p>
<p>type: keyword</p>
<p>example: www</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">dns.question.top_level_domain</code></strong></span>
</span>
</dt>
<dd>
<p>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 (<a href="http://publicsuffix.org" class="ulink" target="_top">http://publicsuffix.org</a>). Trying to approximate this by simply taking the last label will not work well for effective TLDs such as "co.uk".</p>
<p>type: keyword</p>
<p>example: co.uk</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">dns.question.type</code></strong></span>
</span>
</dt>
<dd>
<p>The type of record being queried.</p>
<p>type: keyword</p>
<p>example: AAAA</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">dns.resolved_ip</code></strong></span>
</span>
</dt>
<dd>
<p>Array containing all IPs seen in <code class="literal">answers.data</code>.
The <code class="literal">answers</code> array can be difficult to use, because of the variety of data formats it can contain. Extracting all IP addresses seen in there to <code class="literal">dns.resolved_ip</code> makes it possible to index them as IP addresses, and makes them easier to visualize and query for.</p>
<p>type: ip</p>
<p>example: [<em>10.10.10.10</em>, <em>10.10.10.11</em>]</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">dns.response_code</code></strong></span>
</span>
</dt>
<dd>
<p>The DNS response code.</p>
<p>type: keyword</p>
<p>example: NOERROR</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">dns.type</code></strong></span>
</span>
</dt>
<dd>
<p>The type of DNS event captured, query or answer.
If your source of DNS events only gives you DNS queries, you should only create dns events of type <code class="literal">dns.type:query</code>.
If your source of DNS events gives you answers as well, you should create one event per query (optionally as soon as the query is seen). And a second event containing all query details as well as an array of answers.</p>
<p>type: keyword</p>
<p>example: answer</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_ecs"></a>ecs</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.7/docs/fields.asciidoc">edit</a></div>
<p>Meta-information specific to ECS.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">ecs.version</code></strong></span>
</span>
</dt>
<dd>
<p>ECS version this event conforms to. <code class="literal">ecs.version</code> is a required field and must exist in all events.
When querying across multiple indices&#8201;&#8212;&#8201;which may conform to slightly different ECS versions&#8201;&#8212;&#8201;this field lets integrations adjust to the schema version of the events.</p>
<p>type: keyword</p>
<p>example: 1.0.0</p>
<p>required: True</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_error_2"></a>error</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.7/docs/fields.asciidoc">edit</a></div>
<p>These fields can represent errors of any kind.
Use them for errors that happen while fetching events or in cases where the event itself contains an error.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">error.code</code></strong></span>
</span>
</dt>
<dd>
<p>Error code describing the error.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">error.id</code></strong></span>
</span>
</dt>
<dd>
<p>Unique identifier for the error.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">error.message</code></strong></span>
</span>
</dt>
<dd>
<p>Error message.</p>
<p>type: text</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">error.stack_trace</code></strong></span>
</span>
</dt>
<dd>
<p>The stack trace of this error in plain text.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">error.stack_trace.text</code></strong></span>
</span>
</dt>
<dd>
<p>type: text</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">error.type</code></strong></span>
</span>
</dt>
<dd>
<p>The type of the error, for example the class name of the exception.</p>
<p>type: keyword</p>
<p>example: java.lang.NullPointerException</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_event"></a>event</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.7/docs/fields.asciidoc">edit</a></div>
<p>The event fields are used for context information about the log or metric event itself.
A log is defined as an event containing details of something that happened. Log events must include the time at which the thing happened. Examples of log events include a process starting on a host, a network packet being sent from a source to a destination, or a network connection between a client and a server being initiated or closed. A metric is defined as an event containing one or more numerical measurements and the time at which the measurement was taken. Examples of metric events include memory pressure measured on a host and device temperature. See the <code class="literal">event.kind</code> definition in this section for additional details about metric and state events.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">event.action</code></strong></span>
</span>
</dt>
<dd>
<p>The action captured by the event.
This describes the information in the event. It is more specific than <code class="literal">event.category</code>. Examples are <code class="literal">group-add</code>, <code class="literal">process-started</code>, <code class="literal">file-created</code>. The value is normally defined by the implementer.</p>
<p>type: keyword</p>
<p>example: user-password-change</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">event.category</code></strong></span>
</span>
</dt>
<dd>
<p>This is one of four ECS Categorization Fields, and indicates the second level in the ECS category hierarchy.
<code class="literal">event.category</code> represents the "big buckets" of ECS categories. For example, filtering on <code class="literal">event.category:process</code> yields all events relating to process activity. This field is closely related to <code class="literal">event.type</code>, which is used as a subcategory.
This field is an array. This will allow proper categorization of some events that fall in multiple categories.</p>
<p>type: keyword</p>
<p>example: authentication</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">event.code</code></strong></span>
</span>
</dt>
<dd>
<p>Identification code for this event, if one exists.
Some event sources use event codes to identify messages unambiguously, regardless of message language or wording adjustments over time. An example of this is the Windows Event ID.</p>
<p>type: keyword</p>
<p>example: 4648</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">event.created</code></strong></span>
</span>
</dt>
<dd>
<p>event.created contains the date/time when the event was first read by an agent, or by your pipeline.
This field is distinct from @timestamp in that @timestamp typically contain the time extracted from the original event.
In most situations, these two timestamps will be slightly different. The difference can be used to calculate the delay between your source generating an event, and the time when your agent first processed it. This can be used to monitor your agent&#8217;s or pipeline&#8217;s ability to keep up with your event source.
In case the two timestamps are identical, @timestamp should be used.</p>
<p>type: date</p>
<p>example: 2016-05-23T08:05:34.857Z</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">event.dataset</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the dataset.
If an event source publishes more than one type of log or events (e.g. access log, error log), the dataset is used to specify which one the event comes from.
It&#8217;s recommended but not required to start the dataset name with the module name, followed by a dot, then the dataset name.</p>
<p>type: keyword</p>
<p>example: apache.access</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">event.duration</code></strong></span>
</span>
</dt>
<dd>
<p>Duration of the event in nanoseconds.
If event.start and event.end are known this value should be the difference between the end and start time.</p>
<p>type: long</p>
<p>format: duration</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">event.end</code></strong></span>
</span>
</dt>
<dd>
<p>event.end contains the date when the event ended or when the activity was last observed.</p>
<p>type: date</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">event.hash</code></strong></span>
</span>
</dt>
<dd>
<p>Hash (perhaps logstash fingerprint) of raw field to be able to demonstrate log integrity.</p>
<p>type: keyword</p>
<p>example: 123456789012345678901234567890ABCD</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">event.id</code></strong></span>
</span>
</dt>
<dd>
<p>Unique ID to describe the event.</p>
<p>type: keyword</p>
<p>example: 8a4f500d</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">event.ingested</code></strong></span>
</span>
</dt>
<dd>
<p>Timestamp when an event arrived in the central data store.
This is different from <code class="literal">@timestamp</code>, which is when the event originally occurred.  It&#8217;s also different from <code class="literal">event.created</code>, which is meant to capture the first time an agent saw the event.
In normal conditions, assuming no tampering, the timestamps should chronologically look like this: <code class="literal">@timestamp</code> &lt; <code class="literal">event.created</code> &lt; <code class="literal">event.ingested</code>.</p>
<p>type: date</p>
<p>example: 2016-05-23T08:05:35.101Z</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">event.kind</code></strong></span>
</span>
</dt>
<dd>
<p>This is one of four ECS Categorization Fields, and indicates the highest level in the ECS category hierarchy.
<code class="literal">event.kind</code> gives high-level information about what type of information the event contains, without being specific to the contents of the event. For example, values of this field distinguish alert events from metric events.
The value of this field can be used to inform how these kinds of events should be handled. They may warrant different retention, different access control, it may also help understand whether the data coming in at a regular interval or not.</p>
<p>type: keyword</p>
<p>example: alert</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">event.module</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the module this data is coming from.
If your monitoring agent supports the concept of modules or plugins to process events of a given source (e.g. Apache logs), <code class="literal">event.module</code> should contain the name of this module.</p>
<p>type: keyword</p>
<p>example: apache</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">event.original</code></strong></span>
</span>
</dt>
<dd>
<p>Raw text message of entire event. Used to demonstrate log integrity.
This field is not indexed and doc_values are disabled. It cannot be searched, but it can be retrieved from <code class="literal">_source</code>.</p>
<p>type: keyword</p>
<p>example: Sep 19 08:26:10 host CEF:0&#124;Security&#124; threatmanager&#124;1.0&#124;100&#124; worm successfully stopped&#124;10&#124;src=10.0.0.1 dst=2.1.2.2spt=1232</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">event.outcome</code></strong></span>
</span>
</dt>
<dd>
<p>This is one of four ECS Categorization Fields, and indicates the lowest level in the ECS category hierarchy.
<code class="literal">event.outcome</code> simply denotes whether the event represents a success or a failure from the perspective of the entity that produced the event.
Note that when a single transaction is described in multiple events, each event may populate different values of <code class="literal">event.outcome</code>, according to their perspective.
Also note that in the case of a compound event (a single event that contains multiple logical events), this field should be populated with the value that best captures the overall success or failure from the perspective of the event producer.
Further note that not all events will have an associated outcome. For example, this field is generally not populated for metric events, events with <code class="literal">event.type:info</code>, or any events for which an outcome does not make logical sense.</p>
<p>type: keyword</p>
<p>example: success</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">event.provider</code></strong></span>
</span>
</dt>
<dd>
<p>Source of the event.
Event transports such as Syslog or the Windows Event Log typically mention the source of an event. It can be the name of the software that generated the event (e.g. Sysmon, httpd), or of a subsystem of the operating system (kernel, Microsoft-Windows-Security-Auditing).</p>
<p>type: keyword</p>
<p>example: kernel</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">event.reference</code></strong></span>
</span>
</dt>
<dd>
<p>Reference URL linking to additional information about this event.
This URL links to a static definition of the this event. Alert events, indicated by <code class="literal">event.kind:alert</code>, are a common use case for this field.</p>
<p>type: keyword</p>
<p>example: <a href="https://system.vendor.com/event/#0001234" class="ulink" target="_top">https://system.vendor.com/event/#0001234</a></p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">event.risk_score</code></strong></span>
</span>
</dt>
<dd>
<p>Risk score or priority of the event (e.g. security solutions). Use your system&#8217;s original value here.</p>
<p>type: float</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">event.risk_score_norm</code></strong></span>
</span>
</dt>
<dd>
<p>Normalized risk score or priority of the event, on a scale of 0 to 100.
This is mainly useful if you use more than one system that assigns risk scores, and you want to see a normalized value across all systems.</p>
<p>type: float</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">event.sequence</code></strong></span>
</span>
</dt>
<dd>
<p>Sequence number of the event.
The sequence number is a value published by some event sources, to make the exact ordering of events unambiguous, regardless of the timestamp precision.</p>
<p>type: long</p>
<p>format: string</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">event.severity</code></strong></span>
</span>
</dt>
<dd>
<p>The numeric severity of the event according to your event source.
What the different severity values mean can be different between sources and use cases. It&#8217;s up to the implementer to make sure severities are consistent across events from the same source.
The Syslog severity belongs in <code class="literal">log.syslog.severity.code</code>. <code class="literal">event.severity</code> is meant to represent the severity according to the event source (e.g. firewall, IDS). If the event source does not publish its own severity, you may optionally copy the <code class="literal">log.syslog.severity.code</code> to <code class="literal">event.severity</code>.</p>
<p>type: long</p>
<p>example: 7</p>
<p>format: string</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">event.start</code></strong></span>
</span>
</dt>
<dd>
<p>event.start contains the date when the event started or when the activity was first observed.</p>
<p>type: date</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">event.timezone</code></strong></span>
</span>
</dt>
<dd>
<p>This field should be populated when the event&#8217;s timestamp does not include timezone information already (e.g. default Syslog timestamps). It&#8217;s optional otherwise.
Acceptable timezone formats are: a canonical ID (e.g. "Europe/Amsterdam"), abbreviated (e.g. "EST") or an HH:mm differential (e.g. "-05:00").</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">event.type</code></strong></span>
</span>
</dt>
<dd>
<p>This is one of four ECS Categorization Fields, and indicates the third level in the ECS category hierarchy.
<code class="literal">event.type</code> represents a categorization "sub-bucket" that, when used along with the <code class="literal">event.category</code> field values, enables filtering events down to a level appropriate for single visualization.
This field is an array. This will allow proper categorization of some events that fall in multiple event types.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">event.url</code></strong></span>
</span>
</dt>
<dd>
<p>URL linking to an external system to continue investigation of this event.
This URL links to another system where in-depth investigation of the specific occurence of this event can take place. Alert events, indicated by <code class="literal">event.kind:alert</code>, are a common use case for this field.</p>
<p>type: keyword</p>
<p>example: <a href="https://mysystem.mydomain.com/alert/5271dedb-f5b0-4218-87f0-4ac4870a38fe" class="ulink" target="_top">https://mysystem.mydomain.com/alert/5271dedb-f5b0-4218-87f0-4ac4870a38fe</a></p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_file"></a>file</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.7/docs/fields.asciidoc">edit</a></div>
<p>A file is defined as a set of information that has been created on, or has existed on a filesystem.
File objects can be associated with host events, network events, and/or file events (e.g., those produced by File Integrity Monitoring [FIM] products or services). File fields provide details about the affected file associated with the event or metric.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">file.accessed</code></strong></span>
</span>
</dt>
<dd>
<p>Last time the file was accessed.
Note that not all filesystems keep track of access time.</p>
<p>type: date</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">file.attributes</code></strong></span>
</span>
</dt>
<dd>
<p>Array of file attributes.
Attributes names will vary by platform. Here&#8217;s a non-exhaustive list of values that are expected in this field: archive, compressed, directory, encrypted, execute, hidden, read, readonly, system, write.</p>
<p>type: keyword</p>
<p>example: ["readonly", "system"]</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">file.code_signature.exists</code></strong></span>
</span>
</dt>
<dd>
<p>Boolean to capture if a signature is present.</p>
<p>type: boolean</p>
<p>example: true</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">file.code_signature.status</code></strong></span>
</span>
</dt>
<dd>
<p>Additional information about the certificate status.
This is useful for logging cryptographic errors with the certificate validity or trust status. Leave unpopulated if the validity or trust of the certificate was unchecked.</p>
<p>type: keyword</p>
<p>example: ERROR_UNTRUSTED_ROOT</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">file.code_signature.subject_name</code></strong></span>
</span>
</dt>
<dd>
<p>Subject name of the code signer</p>
<p>type: keyword</p>
<p>example: Microsoft Corporation</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">file.code_signature.trusted</code></strong></span>
</span>
</dt>
<dd>
<p>Stores the trust status of the certificate chain.
Validating the trust of the certificate chain may be complicated, and this field should only be populated by tools that actively check the status.</p>
<p>type: boolean</p>
<p>example: true</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">file.code_signature.valid</code></strong></span>
</span>
</dt>
<dd>
<p>Boolean to capture if the digital signature is verified against the binary content.
Leave unpopulated if a certificate was unchecked.</p>
<p>type: boolean</p>
<p>example: true</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">file.created</code></strong></span>
</span>
</dt>
<dd>
<p>File creation time.
Note that not all filesystems store the creation time.</p>
<p>type: date</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">file.ctime</code></strong></span>
</span>
</dt>
<dd>
<p>Last time the file attributes or metadata changed.
Note that changes to the file content will update <code class="literal">mtime</code>. This implies <code class="literal">ctime</code> will be adjusted at the same time, since <code class="literal">mtime</code> is an attribute of the file.</p>
<p>type: date</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">file.device</code></strong></span>
</span>
</dt>
<dd>
<p>Device that is the source of the file.</p>
<p>type: keyword</p>
<p>example: sda</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">file.directory</code></strong></span>
</span>
</dt>
<dd>
<p>Directory where the file is located. It should include the drive letter, when appropriate.</p>
<p>type: keyword</p>
<p>example: /home/alice</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">file.drive_letter</code></strong></span>
</span>
</dt>
<dd>
<p>Drive letter where the file is located. This field is only relevant on Windows.
The value should be uppercase, and not include the colon.</p>
<p>type: keyword</p>
<p>example: C</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">file.extension</code></strong></span>
</span>
</dt>
<dd>
<p>File extension.</p>
<p>type: keyword</p>
<p>example: png</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">file.gid</code></strong></span>
</span>
</dt>
<dd>
<p>Primary group ID (GID) of the file.</p>
<p>type: keyword</p>
<p>example: 1001</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">file.group</code></strong></span>
</span>
</dt>
<dd>
<p>Primary group name of the file.</p>
<p>type: keyword</p>
<p>example: alice</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">file.hash.md5</code></strong></span>
</span>
</dt>
<dd>
<p>MD5 hash.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">file.hash.sha1</code></strong></span>
</span>
</dt>
<dd>
<p>SHA1 hash.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">file.hash.sha256</code></strong></span>
</span>
</dt>
<dd>
<p>SHA256 hash.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">file.hash.sha512</code></strong></span>
</span>
</dt>
<dd>
<p>SHA512 hash.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">file.inode</code></strong></span>
</span>
</dt>
<dd>
<p>Inode representing the file in the filesystem.</p>
<p>type: keyword</p>
<p>example: 256383</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">file.mime_type</code></strong></span>
</span>
</dt>
<dd>
<p>MIME type should identify the format of the file or stream of bytes using <a href="https://www.iana.org/assignments/media-types/media-types.xhtml" class="ulink" target="_top">IANA official types</a>, where possible. When more than one type is applicable, the most specific type should be used.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">file.mode</code></strong></span>
</span>
</dt>
<dd>
<p>Mode of the file in octal representation.</p>
<p>type: keyword</p>
<p>example: 0640</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">file.mtime</code></strong></span>
</span>
</dt>
<dd>
<p>Last time the file content was modified.</p>
<p>type: date</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">file.name</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the file including the extension, without the directory.</p>
<p>type: keyword</p>
<p>example: example.png</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">file.owner</code></strong></span>
</span>
</dt>
<dd>
<p>File owner&#8217;s username.</p>
<p>type: keyword</p>
<p>example: alice</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">file.path</code></strong></span>
</span>
</dt>
<dd>
<p>Full path to the file, including the file name. It should include the drive letter, when appropriate.</p>
<p>type: keyword</p>
<p>example: /home/alice/example.png</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">file.path.text</code></strong></span>
</span>
</dt>
<dd>
<p>type: text</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">file.pe.company</code></strong></span>
</span>
</dt>
<dd>
<p>Internal company name of the file, provided at compile-time.</p>
<p>type: keyword</p>
<p>example: Microsoft Corporation</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">file.pe.description</code></strong></span>
</span>
</dt>
<dd>
<p>Internal description of the file, provided at compile-time.</p>
<p>type: keyword</p>
<p>example: Paint</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">file.pe.file_version</code></strong></span>
</span>
</dt>
<dd>
<p>Internal version of the file, provided at compile-time.</p>
<p>type: keyword</p>
<p>example: 6.3.9600.17415</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">file.pe.original_file_name</code></strong></span>
</span>
</dt>
<dd>
<p>Internal name of the file, provided at compile-time.</p>
<p>type: keyword</p>
<p>example: MSPAINT.EXE</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">file.pe.product</code></strong></span>
</span>
</dt>
<dd>
<p>Internal product name of the file, provided at compile-time.</p>
<p>type: keyword</p>
<p>example: Microsoft® Windows® Operating System</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">file.size</code></strong></span>
</span>
</dt>
<dd>
<p>File size in bytes.
Only relevant when <code class="literal">file.type</code> is "file".</p>
<p>type: long</p>
<p>example: 16384</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">file.target_path</code></strong></span>
</span>
</dt>
<dd>
<p>Target path for symlinks.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">file.target_path.text</code></strong></span>
</span>
</dt>
<dd>
<p>type: text</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">file.type</code></strong></span>
</span>
</dt>
<dd>
<p>File type (file, dir, or symlink).</p>
<p>type: keyword</p>
<p>example: file</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">file.uid</code></strong></span>
</span>
</dt>
<dd>
<p>The user ID (UID) or security identifier (SID) of the file owner.</p>
<p>type: keyword</p>
<p>example: 1001</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_geo"></a>geo</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.7/docs/fields.asciidoc">edit</a></div>
<p>Geo fields can carry data about a specific location related to an event.
This geolocation information can be derived from techniques such as Geo IP, or be user-supplied.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">geo.city_name</code></strong></span>
</span>
</dt>
<dd>
<p>City name.</p>
<p>type: keyword</p>
<p>example: Montreal</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">geo.continent_name</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the continent.</p>
<p>type: keyword</p>
<p>example: North America</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">geo.country_iso_code</code></strong></span>
</span>
</dt>
<dd>
<p>Country ISO code.</p>
<p>type: keyword</p>
<p>example: CA</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">geo.country_name</code></strong></span>
</span>
</dt>
<dd>
<p>Country name.</p>
<p>type: keyword</p>
<p>example: Canada</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">geo.location</code></strong></span>
</span>
</dt>
<dd>
<p>Longitude and latitude.</p>
<p>type: geo_point</p>
<p>example: { "lon": -73.614830, "lat": 45.505918 }</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">geo.name</code></strong></span>
</span>
</dt>
<dd>
<p>User-defined description of a location, at the level of granularity they care about.
Could be the name of their data centers, the floor number, if this describes a local physical entity, city names.
Not typically used in automated geolocation.</p>
<p>type: keyword</p>
<p>example: boston-dc</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">geo.region_iso_code</code></strong></span>
</span>
</dt>
<dd>
<p>Region ISO code.</p>
<p>type: keyword</p>
<p>example: CA-QC</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">geo.region_name</code></strong></span>
</span>
</dt>
<dd>
<p>Region name.</p>
<p>type: keyword</p>
<p>example: Quebec</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_group"></a>group</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.7/docs/fields.asciidoc">edit</a></div>
<p>The group fields are meant to represent groups that are relevant to the event.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">group.domain</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the directory the group is a member of.
For example, an LDAP or Active Directory domain name.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">group.id</code></strong></span>
</span>
</dt>
<dd>
<p>Unique identifier for the group on the system/platform.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">group.name</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the group.</p>
<p>type: keyword</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_hash"></a>hash</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.7/docs/fields.asciidoc">edit</a></div>
<p>The hash fields represent different hash algorithms and their values.
Field names for common hashes (e.g. MD5, SHA1) are predefined. Add fields for other hashes by lowercasing the hash algorithm name and using underscore separators as appropriate (snake case, e.g. sha3_512).</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">hash.md5</code></strong></span>
</span>
</dt>
<dd>
<p>MD5 hash.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">hash.sha1</code></strong></span>
</span>
</dt>
<dd>
<p>SHA1 hash.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">hash.sha256</code></strong></span>
</span>
</dt>
<dd>
<p>SHA256 hash.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">hash.sha512</code></strong></span>
</span>
</dt>
<dd>
<p>SHA512 hash.</p>
<p>type: keyword</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_host_2"></a>host</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.7/docs/fields.asciidoc">edit</a></div>
<p>A host is defined as a general computing instance.
ECS host.* fields should be populated with details about the host on which the event happened, or from which the measurement was taken. Host types include hardware, virtual machines, Docker containers, and Kubernetes nodes.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">host.architecture</code></strong></span>
</span>
</dt>
<dd>
<p>Operating system architecture.</p>
<p>type: keyword</p>
<p>example: x86_64</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">host.domain</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the domain of which the host is a member.
For example, on Windows this could be the host&#8217;s Active Directory domain or NetBIOS domain name. For Linux this could be the domain of the host&#8217;s LDAP provider.</p>
<p>type: keyword</p>
<p>example: CONTOSO</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">host.geo.city_name</code></strong></span>
</span>
</dt>
<dd>
<p>City name.</p>
<p>type: keyword</p>
<p>example: Montreal</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">host.geo.continent_name</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the continent.</p>
<p>type: keyword</p>
<p>example: North America</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">host.geo.country_iso_code</code></strong></span>
</span>
</dt>
<dd>
<p>Country ISO code.</p>
<p>type: keyword</p>
<p>example: CA</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">host.geo.country_name</code></strong></span>
</span>
</dt>
<dd>
<p>Country name.</p>
<p>type: keyword</p>
<p>example: Canada</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">host.geo.location</code></strong></span>
</span>
</dt>
<dd>
<p>Longitude and latitude.</p>
<p>type: geo_point</p>
<p>example: { "lon": -73.614830, "lat": 45.505918 }</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">host.geo.name</code></strong></span>
</span>
</dt>
<dd>
<p>User-defined description of a location, at the level of granularity they care about.
Could be the name of their data centers, the floor number, if this describes a local physical entity, city names.
Not typically used in automated geolocation.</p>
<p>type: keyword</p>
<p>example: boston-dc</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">host.geo.region_iso_code</code></strong></span>
</span>
</dt>
<dd>
<p>Region ISO code.</p>
<p>type: keyword</p>
<p>example: CA-QC</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">host.geo.region_name</code></strong></span>
</span>
</dt>
<dd>
<p>Region name.</p>
<p>type: keyword</p>
<p>example: Quebec</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">host.hostname</code></strong></span>
</span>
</dt>
<dd>
<p>Hostname of the host.
It normally contains what the <code class="literal">hostname</code> command returns on the host machine.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">host.id</code></strong></span>
</span>
</dt>
<dd>
<p>Unique host id.
As hostname is not always unique, use values that are meaningful in your environment.
Example: The current usage of <code class="literal">beat.name</code>.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">host.ip</code></strong></span>
</span>
</dt>
<dd>
<p>Host ip addresses.</p>
<p>type: ip</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">host.mac</code></strong></span>
</span>
</dt>
<dd>
<p>Host mac addresses.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">host.name</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the host.
It can contain what <code class="literal">hostname</code> returns on Unix systems, the fully qualified domain name, or a name specified by the user. The sender decides which value to use.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">host.os.family</code></strong></span>
</span>
</dt>
<dd>
<p>OS family (such as redhat, debian, freebsd, windows).</p>
<p>type: keyword</p>
<p>example: debian</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">host.os.full</code></strong></span>
</span>
</dt>
<dd>
<p>Operating system name, including the version or code name.</p>
<p>type: keyword</p>
<p>example: Mac OS Mojave</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">host.os.full.text</code></strong></span>
</span>
</dt>
<dd>
<p>type: text</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">host.os.kernel</code></strong></span>
</span>
</dt>
<dd>
<p>Operating system kernel version as a raw string.</p>
<p>type: keyword</p>
<p>example: 4.4.0-112-generic</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">host.os.name</code></strong></span>
</span>
</dt>
<dd>
<p>Operating system name, without the version.</p>
<p>type: keyword</p>
<p>example: Mac OS X</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">host.os.name.text</code></strong></span>
</span>
</dt>
<dd>
<p>type: text</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">host.os.platform</code></strong></span>
</span>
</dt>
<dd>
<p>Operating system platform (such centos, ubuntu, windows).</p>
<p>type: keyword</p>
<p>example: darwin</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">host.os.version</code></strong></span>
</span>
</dt>
<dd>
<p>Operating system version as a raw string.</p>
<p>type: keyword</p>
<p>example: 10.14.1</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">host.type</code></strong></span>
</span>
</dt>
<dd>
<p>Type of host.
For Cloud providers this can be the machine type like <code class="literal">t2.medium</code>. If vm, this could be the container, for example, or other information meaningful in your environment.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">host.uptime</code></strong></span>
</span>
</dt>
<dd>
<p>Seconds the host has been up.</p>
<p>type: long</p>
<p>example: 1325</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">host.user.domain</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the directory the user is a member of.
For example, an LDAP or Active Directory domain name.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">host.user.email</code></strong></span>
</span>
</dt>
<dd>
<p>User email address.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">host.user.full_name</code></strong></span>
</span>
</dt>
<dd>
<p>User&#8217;s full name, if available.</p>
<p>type: keyword</p>
<p>example: Albert Einstein</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">host.user.full_name.text</code></strong></span>
</span>
</dt>
<dd>
<p>type: text</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">host.user.group.domain</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the directory the group is a member of.
For example, an LDAP or Active Directory domain name.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">host.user.group.id</code></strong></span>
</span>
</dt>
<dd>
<p>Unique identifier for the group on the system/platform.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">host.user.group.name</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the group.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">host.user.hash</code></strong></span>
</span>
</dt>
<dd>
<p>Unique user hash to correlate information for a user in anonymized form.
Useful if <code class="literal">user.id</code> or <code class="literal">user.name</code> contain confidential information and cannot be used.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">host.user.id</code></strong></span>
</span>
</dt>
<dd>
<p>Unique identifiers of the user.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">host.user.name</code></strong></span>
</span>
</dt>
<dd>
<p>Short name or login of the user.</p>
<p>type: keyword</p>
<p>example: albert</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">host.user.name.text</code></strong></span>
</span>
</dt>
<dd>
<p>type: text</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_http"></a>http</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.7/docs/fields.asciidoc">edit</a></div>
<p>Fields related to HTTP activity. Use the <code class="literal">url</code> field set to store the url of the request.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">http.request.body.bytes</code></strong></span>
</span>
</dt>
<dd>
<p>Size in bytes of the request body.</p>
<p>type: long</p>
<p>example: 887</p>
<p>format: bytes</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">http.request.body.content</code></strong></span>
</span>
</dt>
<dd>
<p>The full HTTP request body.</p>
<p>type: keyword</p>
<p>example: Hello world</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">http.request.body.content.text</code></strong></span>
</span>
</dt>
<dd>
<p>type: text</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">http.request.bytes</code></strong></span>
</span>
</dt>
<dd>
<p>Total size in bytes of the request (body and headers).</p>
<p>type: long</p>
<p>example: 1437</p>
<p>format: bytes</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">http.request.method</code></strong></span>
</span>
</dt>
<dd>
<p>HTTP request method.
The field value must be normalized to lowercase for querying. See the documentation section "Implementing ECS".</p>
<p>type: keyword</p>
<p>example: get, post, put</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">http.request.referrer</code></strong></span>
</span>
</dt>
<dd>
<p>Referrer for this HTTP request.</p>
<p>type: keyword</p>
<p>example: <a href="https://blog.example.com/" class="ulink" target="_top">https://blog.example.com/</a></p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">http.response.body.bytes</code></strong></span>
</span>
</dt>
<dd>
<p>Size in bytes of the response body.</p>
<p>type: long</p>
<p>example: 887</p>
<p>format: bytes</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">http.response.body.content</code></strong></span>
</span>
</dt>
<dd>
<p>The full HTTP response body.</p>
<p>type: keyword</p>
<p>example: Hello world</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">http.response.body.content.text</code></strong></span>
</span>
</dt>
<dd>
<p>type: text</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">http.response.bytes</code></strong></span>
</span>
</dt>
<dd>
<p>Total size in bytes of the response (body and headers).</p>
<p>type: long</p>
<p>example: 1437</p>
<p>format: bytes</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">http.response.status_code</code></strong></span>
</span>
</dt>
<dd>
<p>HTTP response status code.</p>
<p>type: long</p>
<p>example: 404</p>
<p>format: string</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">http.version</code></strong></span>
</span>
</dt>
<dd>
<p>HTTP version.</p>
<p>type: keyword</p>
<p>example: 1.1</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_interface"></a>interface</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.7/docs/fields.asciidoc">edit</a></div>
<p>The interface fields are used to record ingress and egress interface information when reported by an observer (e.g. firewall, router, load balancer) in the context of the observer handling a network connection.  In the case of a single observer interface (e.g. network sensor on a span port) only the observer.ingress information should be populated.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">interface.alias</code></strong></span>
</span>
</dt>
<dd>
<p>Interface alias as reported by the system, typically used in firewall implementations for e.g. inside, outside, or dmz logical interface naming.</p>
<p>type: keyword</p>
<p>example: outside</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">interface.id</code></strong></span>
</span>
</dt>
<dd>
<p>Interface ID as reported by an observer (typically SNMP interface ID).</p>
<p>type: keyword</p>
<p>example: 10</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">interface.name</code></strong></span>
</span>
</dt>
<dd>
<p>Interface name as reported by the system.</p>
<p>type: keyword</p>
<p>example: eth0</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_log_2"></a>log</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.7/docs/fields.asciidoc">edit</a></div>
<p>Details about the event&#8217;s logging mechanism or logging transport.
The log.* fields are typically populated with details about the logging mechanism used to create and/or transport the event. For example, syslog details belong under <code class="literal">log.syslog.*</code>.
The details specific to your event source are typically not logged under <code class="literal">log.*</code>, but rather in <code class="literal">event.*</code> or in other ECS fields.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">log.level</code></strong></span>
</span>
</dt>
<dd>
<p>Original log level of the log event.
If the source of the event provides a log level or textual severity, this is the one that goes in <code class="literal">log.level</code>. If your source doesn&#8217;t specify one, you may put your event transport&#8217;s severity here (e.g. Syslog severity).
Some examples are <code class="literal">warn</code>, <code class="literal">err</code>, <code class="literal">i</code>, <code class="literal">informational</code>.</p>
<p>type: keyword</p>
<p>example: error</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">log.logger</code></strong></span>
</span>
</dt>
<dd>
<p>The name of the logger inside an application. This is usually the name of the class which initialized the logger, or can be a custom name.</p>
<p>type: keyword</p>
<p>example: org.elasticsearch.bootstrap.Bootstrap</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">log.origin.file.line</code></strong></span>
</span>
</dt>
<dd>
<p>The line number of the file containing the source code which originated the log event.</p>
<p>type: integer</p>
<p>example: 42</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">log.origin.file.name</code></strong></span>
</span>
</dt>
<dd>
<p>The name of the file containing the source code which originated the log event. Note that this is not the name of the log file.</p>
<p>type: keyword</p>
<p>example: Bootstrap.java</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">log.origin.function</code></strong></span>
</span>
</dt>
<dd>
<p>The name of the function or method which originated the log event.</p>
<p>type: keyword</p>
<p>example: init</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">log.original</code></strong></span>
</span>
</dt>
<dd>
<p>This is the original log message and contains the full log message before splitting it up in multiple parts.
In contrast to the <code class="literal">message</code> field which can contain an extracted part of the log message, this field contains the original, full log message. It can have already some modifications applied like encoding or new lines removed to clean up the log message.
This field is not indexed and doc_values are disabled so it can&#8217;t be queried but the value can be retrieved from <code class="literal">_source</code>.</p>
<p>type: keyword</p>
<p>example: Sep 19 08:26:10 localhost My log</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">log.syslog</code></strong></span>
</span>
</dt>
<dd>
<p>The Syslog metadata of the event, if the event was transmitted via Syslog. Please see RFCs 5424 or 3164.</p>
<p>type: object</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">log.syslog.facility.code</code></strong></span>
</span>
</dt>
<dd>
<p>The Syslog numeric facility of the log event, if available.
According to RFCs 5424 and 3164, this value should be an integer between 0 and 23.</p>
<p>type: long</p>
<p>example: 23</p>
<p>format: string</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">log.syslog.facility.name</code></strong></span>
</span>
</dt>
<dd>
<p>The Syslog text-based facility of the log event, if available.</p>
<p>type: keyword</p>
<p>example: local7</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">log.syslog.priority</code></strong></span>
</span>
</dt>
<dd>
<p>Syslog numeric priority of the event, if available.
According to RFCs 5424 and 3164, the priority is 8 * facility + severity. This number is therefore expected to contain a value between 0 and 191.</p>
<p>type: long</p>
<p>example: 135</p>
<p>format: string</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">log.syslog.severity.code</code></strong></span>
</span>
</dt>
<dd>
<p>The Syslog numeric severity of the log event, if available.
If the event source publishing via Syslog provides a different numeric severity value (e.g. firewall, IDS), your source&#8217;s numeric severity should go to <code class="literal">event.severity</code>. If the event source does not specify a distinct severity, you can optionally copy the Syslog severity to <code class="literal">event.severity</code>.</p>
<p>type: long</p>
<p>example: 3</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">log.syslog.severity.name</code></strong></span>
</span>
</dt>
<dd>
<p>The Syslog numeric severity of the log event, if available.
If the event source publishing via Syslog provides a different severity value (e.g. firewall, IDS), your source&#8217;s text severity should go to <code class="literal">log.level</code>. If the event source does not specify a distinct severity, you can optionally copy the Syslog severity to <code class="literal">log.level</code>.</p>
<p>type: keyword</p>
<p>example: Error</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_network"></a>network</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.7/docs/fields.asciidoc">edit</a></div>
<p>The network is defined as the communication path over which a host or network event happens.
The network.* fields should be populated with details about the network activity associated with an event.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">network.application</code></strong></span>
</span>
</dt>
<dd>
<p>A name given to an application level protocol. This can be arbitrarily assigned for things like microservices, but also apply to things like skype, icq, facebook, twitter. This would be used in situations where the vendor or service can be decoded such as from the source/dest IP owners, ports, or wire format.
The field value must be normalized to lowercase for querying. See the documentation section "Implementing ECS".</p>
<p>type: keyword</p>
<p>example: aim</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">network.bytes</code></strong></span>
</span>
</dt>
<dd>
<p>Total bytes transferred in both directions.
If <code class="literal">source.bytes</code> and <code class="literal">destination.bytes</code> are known, <code class="literal">network.bytes</code> is their sum.</p>
<p>type: long</p>
<p>example: 368</p>
<p>format: bytes</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">network.community_id</code></strong></span>
</span>
</dt>
<dd>
<p>A hash of source and destination IPs and ports, as well as the protocol used in a communication. This is a tool-agnostic standard to identify flows.
Learn more at <a href="https://github.com/corelight/community-id-spec" class="ulink" target="_top">https://github.com/corelight/community-id-spec</a>.</p>
<p>type: keyword</p>
<p>example: 1:hO+sN4H+MG5MY/8hIrXPqc4ZQz0=</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">network.direction</code></strong></span>
</span>
</dt>
<dd>
<p>Direction of the network traffic.
Recommended values are:
  * inbound
  * outbound
  * internal
  * external
  * unknown</p>
<p>When mapping events from a host-based monitoring context, populate this field from the host&#8217;s point of view.
When mapping events from a network or perimeter-based monitoring context, populate this field from the point of view of your network perimeter.</p>
<p>type: keyword</p>
<p>example: inbound</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">network.forwarded_ip</code></strong></span>
</span>
</dt>
<dd>
<p>Host IP address when the source IP address is the proxy.</p>
<p>type: ip</p>
<p>example: 192.1.1.2</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">network.iana_number</code></strong></span>
</span>
</dt>
<dd>
<p>IANA Protocol Number (<a href="https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml" class="ulink" target="_top">https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml</a>). Standardized list of protocols. This aligns well with NetFlow and sFlow related logs which use the IANA Protocol Number.</p>
<p>type: keyword</p>
<p>example: 6</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">network.inner</code></strong></span>
</span>
</dt>
<dd>
<p>Network.inner fields are added in addition to network.vlan fields to describe  the innermost VLAN when q-in-q VLAN tagging is present. Allowed fields include  vlan.id and vlan.name. Inner vlan fields are typically used when sending traffic with multiple 802.1q encapsulations to a network sensor (e.g. Zeek, Wireshark.)</p>
<p>type: object</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">network.inner.vlan.id</code></strong></span>
</span>
</dt>
<dd>
<p>VLAN ID as reported by the observer.</p>
<p>type: keyword</p>
<p>example: 10</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">network.inner.vlan.name</code></strong></span>
</span>
</dt>
<dd>
<p>Optional VLAN name as reported by the observer.</p>
<p>type: keyword</p>
<p>example: outside</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">network.name</code></strong></span>
</span>
</dt>
<dd>
<p>Name given by operators to sections of their network.</p>
<p>type: keyword</p>
<p>example: Guest Wifi</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">network.packets</code></strong></span>
</span>
</dt>
<dd>
<p>Total packets transferred in both directions.
If <code class="literal">source.packets</code> and <code class="literal">destination.packets</code> are known, <code class="literal">network.packets</code> is their sum.</p>
<p>type: long</p>
<p>example: 24</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">network.protocol</code></strong></span>
</span>
</dt>
<dd>
<p>L7 Network protocol name. ex. http, lumberjack, transport protocol.
The field value must be normalized to lowercase for querying. See the documentation section "Implementing ECS".</p>
<p>type: keyword</p>
<p>example: http</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">network.transport</code></strong></span>
</span>
</dt>
<dd>
<p>Same as network.iana_number, but instead using the Keyword name of the transport layer (udp, tcp, ipv6-icmp, etc.)
The field value must be normalized to lowercase for querying. See the documentation section "Implementing ECS".</p>
<p>type: keyword</p>
<p>example: tcp</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">network.type</code></strong></span>
</span>
</dt>
<dd>
<p>In the OSI Model this would be the Network Layer. ipv4, ipv6, ipsec, pim, etc
The field value must be normalized to lowercase for querying. See the documentation section "Implementing ECS".</p>
<p>type: keyword</p>
<p>example: ipv4</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">network.vlan.id</code></strong></span>
</span>
</dt>
<dd>
<p>VLAN ID as reported by the observer.</p>
<p>type: keyword</p>
<p>example: 10</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">network.vlan.name</code></strong></span>
</span>
</dt>
<dd>
<p>Optional VLAN name as reported by the observer.</p>
<p>type: keyword</p>
<p>example: outside</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_observer"></a>observer</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.7/docs/fields.asciidoc">edit</a></div>
<p>An observer is defined as a special network, security, or application device used to detect, observe, or create network, security, or application-related events and metrics.
This could be a custom hardware appliance or a server that has been configured to run special network, security, or application software. Examples include firewalls, web proxies, intrusion detection/prevention systems, network monitoring sensors, web application firewalls, data loss prevention systems, and APM servers. The observer.* fields shall be populated with details of the system, if any, that detects, observes and/or creates a network, security, or application event or metric. Message queues and ETL components used in processing events or metrics are not considered observers in ECS.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">observer.egress</code></strong></span>
</span>
</dt>
<dd>
<p>Observer.egress holds information like interface number and name, vlan, and zone information to  classify egress traffic.  Single armed monitoring such as a network sensor on a span port should  only use observer.ingress to categorize traffic.</p>
<p>type: object</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">observer.egress.interface.alias</code></strong></span>
</span>
</dt>
<dd>
<p>Interface alias as reported by the system, typically used in firewall implementations for e.g. inside, outside, or dmz logical interface naming.</p>
<p>type: keyword</p>
<p>example: outside</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">observer.egress.interface.id</code></strong></span>
</span>
</dt>
<dd>
<p>Interface ID as reported by an observer (typically SNMP interface ID).</p>
<p>type: keyword</p>
<p>example: 10</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">observer.egress.interface.name</code></strong></span>
</span>
</dt>
<dd>
<p>Interface name as reported by the system.</p>
<p>type: keyword</p>
<p>example: eth0</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">observer.egress.vlan.id</code></strong></span>
</span>
</dt>
<dd>
<p>VLAN ID as reported by the observer.</p>
<p>type: keyword</p>
<p>example: 10</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">observer.egress.vlan.name</code></strong></span>
</span>
</dt>
<dd>
<p>Optional VLAN name as reported by the observer.</p>
<p>type: keyword</p>
<p>example: outside</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">observer.egress.zone</code></strong></span>
</span>
</dt>
<dd>
<p>Network zone of outbound traffic as reported by the observer to categorize the destination area of egress  traffic, e.g. Internal, External, DMZ, HR, Legal, etc.</p>
<p>type: keyword</p>
<p>example: Public_Internet</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">observer.geo.city_name</code></strong></span>
</span>
</dt>
<dd>
<p>City name.</p>
<p>type: keyword</p>
<p>example: Montreal</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">observer.geo.continent_name</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the continent.</p>
<p>type: keyword</p>
<p>example: North America</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">observer.geo.country_iso_code</code></strong></span>
</span>
</dt>
<dd>
<p>Country ISO code.</p>
<p>type: keyword</p>
<p>example: CA</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">observer.geo.country_name</code></strong></span>
</span>
</dt>
<dd>
<p>Country name.</p>
<p>type: keyword</p>
<p>example: Canada</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">observer.geo.location</code></strong></span>
</span>
</dt>
<dd>
<p>Longitude and latitude.</p>
<p>type: geo_point</p>
<p>example: { "lon": -73.614830, "lat": 45.505918 }</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">observer.geo.name</code></strong></span>
</span>
</dt>
<dd>
<p>User-defined description of a location, at the level of granularity they care about.
Could be the name of their data centers, the floor number, if this describes a local physical entity, city names.
Not typically used in automated geolocation.</p>
<p>type: keyword</p>
<p>example: boston-dc</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">observer.geo.region_iso_code</code></strong></span>
</span>
</dt>
<dd>
<p>Region ISO code.</p>
<p>type: keyword</p>
<p>example: CA-QC</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">observer.geo.region_name</code></strong></span>
</span>
</dt>
<dd>
<p>Region name.</p>
<p>type: keyword</p>
<p>example: Quebec</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">observer.hostname</code></strong></span>
</span>
</dt>
<dd>
<p>Hostname of the observer.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">observer.ingress</code></strong></span>
</span>
</dt>
<dd>
<p>Observer.ingress holds information like interface number and name, vlan, and zone information to  classify ingress traffic.  Single armed monitoring such as a network sensor on a span port should  only use observer.ingress to categorize traffic.</p>
<p>type: object</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">observer.ingress.interface.alias</code></strong></span>
</span>
</dt>
<dd>
<p>Interface alias as reported by the system, typically used in firewall implementations for e.g. inside, outside, or dmz logical interface naming.</p>
<p>type: keyword</p>
<p>example: outside</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">observer.ingress.interface.id</code></strong></span>
</span>
</dt>
<dd>
<p>Interface ID as reported by an observer (typically SNMP interface ID).</p>
<p>type: keyword</p>
<p>example: 10</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">observer.ingress.interface.name</code></strong></span>
</span>
</dt>
<dd>
<p>Interface name as reported by the system.</p>
<p>type: keyword</p>
<p>example: eth0</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">observer.ingress.vlan.id</code></strong></span>
</span>
</dt>
<dd>
<p>VLAN ID as reported by the observer.</p>
<p>type: keyword</p>
<p>example: 10</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">observer.ingress.vlan.name</code></strong></span>
</span>
</dt>
<dd>
<p>Optional VLAN name as reported by the observer.</p>
<p>type: keyword</p>
<p>example: outside</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">observer.ingress.zone</code></strong></span>
</span>
</dt>
<dd>
<p>Network zone of incoming traffic as reported by the observer to categorize the source area of ingress  traffic. e.g. internal, External, DMZ, HR, Legal, etc.</p>
<p>type: keyword</p>
<p>example: DMZ</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">observer.ip</code></strong></span>
</span>
</dt>
<dd>
<p>IP addresses of the observer.</p>
<p>type: ip</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">observer.mac</code></strong></span>
</span>
</dt>
<dd>
<p>MAC addresses of the observer</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">observer.name</code></strong></span>
</span>
</dt>
<dd>
<p>Custom name of the observer.
This is a name that can be given to an observer. This can be helpful for example if multiple firewalls of the same model are used in an organization.
If no custom name is needed, the field can be left empty.</p>
<p>type: keyword</p>
<p>example: 1_proxySG</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">observer.os.family</code></strong></span>
</span>
</dt>
<dd>
<p>OS family (such as redhat, debian, freebsd, windows).</p>
<p>type: keyword</p>
<p>example: debian</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">observer.os.full</code></strong></span>
</span>
</dt>
<dd>
<p>Operating system name, including the version or code name.</p>
<p>type: keyword</p>
<p>example: Mac OS Mojave</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">observer.os.full.text</code></strong></span>
</span>
</dt>
<dd>
<p>type: text</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">observer.os.kernel</code></strong></span>
</span>
</dt>
<dd>
<p>Operating system kernel version as a raw string.</p>
<p>type: keyword</p>
<p>example: 4.4.0-112-generic</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">observer.os.name</code></strong></span>
</span>
</dt>
<dd>
<p>Operating system name, without the version.</p>
<p>type: keyword</p>
<p>example: Mac OS X</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">observer.os.name.text</code></strong></span>
</span>
</dt>
<dd>
<p>type: text</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">observer.os.platform</code></strong></span>
</span>
</dt>
<dd>
<p>Operating system platform (such centos, ubuntu, windows).</p>
<p>type: keyword</p>
<p>example: darwin</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">observer.os.version</code></strong></span>
</span>
</dt>
<dd>
<p>Operating system version as a raw string.</p>
<p>type: keyword</p>
<p>example: 10.14.1</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">observer.product</code></strong></span>
</span>
</dt>
<dd>
<p>The product name of the observer.</p>
<p>type: keyword</p>
<p>example: s200</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">observer.serial_number</code></strong></span>
</span>
</dt>
<dd>
<p>Observer serial number.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">observer.type</code></strong></span>
</span>
</dt>
<dd>
<p>The type of the observer the data is coming from.
There is no predefined list of observer types. Some examples are <code class="literal">forwarder</code>, <code class="literal">firewall</code>, <code class="literal">ids</code>, <code class="literal">ips</code>, <code class="literal">proxy</code>, <code class="literal">poller</code>, <code class="literal">sensor</code>, <code class="literal">APM server</code>.</p>
<p>type: keyword</p>
<p>example: firewall</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">observer.vendor</code></strong></span>
</span>
</dt>
<dd>
<p>Vendor name of the observer.</p>
<p>type: keyword</p>
<p>example: Symantec</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">observer.version</code></strong></span>
</span>
</dt>
<dd>
<p>Observer version.</p>
<p>type: keyword</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_organization"></a>organization</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.7/docs/fields.asciidoc">edit</a></div>
<p>The organization fields enrich data with information about the company or entity the data is associated with.
These fields help you arrange or filter data stored in an index by one or multiple organizations.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">organization.id</code></strong></span>
</span>
</dt>
<dd>
<p>Unique identifier for the organization.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">organization.name</code></strong></span>
</span>
</dt>
<dd>
<p>Organization name.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">organization.name.text</code></strong></span>
</span>
</dt>
<dd>
<p>type: text</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_os_3"></a>os</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.7/docs/fields.asciidoc">edit</a></div>
<p>The OS fields contain information about the operating system.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">os.family</code></strong></span>
</span>
</dt>
<dd>
<p>OS family (such as redhat, debian, freebsd, windows).</p>
<p>type: keyword</p>
<p>example: debian</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">os.full</code></strong></span>
</span>
</dt>
<dd>
<p>Operating system name, including the version or code name.</p>
<p>type: keyword</p>
<p>example: Mac OS Mojave</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">os.full.text</code></strong></span>
</span>
</dt>
<dd>
<p>type: text</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">os.kernel</code></strong></span>
</span>
</dt>
<dd>
<p>Operating system kernel version as a raw string.</p>
<p>type: keyword</p>
<p>example: 4.4.0-112-generic</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">os.name</code></strong></span>
</span>
</dt>
<dd>
<p>Operating system name, without the version.</p>
<p>type: keyword</p>
<p>example: Mac OS X</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">os.name.text</code></strong></span>
</span>
</dt>
<dd>
<p>type: text</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">os.platform</code></strong></span>
</span>
</dt>
<dd>
<p>Operating system platform (such centos, ubuntu, windows).</p>
<p>type: keyword</p>
<p>example: darwin</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">os.version</code></strong></span>
</span>
</dt>
<dd>
<p>Operating system version as a raw string.</p>
<p>type: keyword</p>
<p>example: 10.14.1</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_package"></a>package</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.7/docs/fields.asciidoc">edit</a></div>
<p>These fields contain information about an installed software package. It contains general information about a package, such as name, version or size. It also contains installation details, such as time or location.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">package.architecture</code></strong></span>
</span>
</dt>
<dd>
<p>Package architecture.</p>
<p>type: keyword</p>
<p>example: x86_64</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">package.build_version</code></strong></span>
</span>
</dt>
<dd>
<p>Additional information about the build version of the installed package.
For example use the commit SHA of a non-released package.</p>
<p>type: keyword</p>
<p>example: 36f4f7e89dd61b0988b12ee000b98966867710cd</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">package.checksum</code></strong></span>
</span>
</dt>
<dd>
<p>Checksum of the installed package for verification.</p>
<p>type: keyword</p>
<p>example: 68b329da9893e34099c7d8ad5cb9c940</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">package.description</code></strong></span>
</span>
</dt>
<dd>
<p>Description of the package.</p>
<p>type: keyword</p>
<p>example: Open source programming language to build simple/reliable/efficient software.</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">package.install_scope</code></strong></span>
</span>
</dt>
<dd>
<p>Indicating how the package was installed, e.g. user-local, global.</p>
<p>type: keyword</p>
<p>example: global</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">package.installed</code></strong></span>
</span>
</dt>
<dd>
<p>Time when package was installed.</p>
<p>type: date</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">package.license</code></strong></span>
</span>
</dt>
<dd>
<p>License under which the package was released.
Use a short name, e.g. the license identifier from SPDX License List where possible (<a href="https://spdx.org/licenses/" class="ulink" target="_top">https://spdx.org/licenses/</a>).</p>
<p>type: keyword</p>
<p>example: Apache License 2.0</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">package.name</code></strong></span>
</span>
</dt>
<dd>
<p>Package name</p>
<p>type: keyword</p>
<p>example: go</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">package.path</code></strong></span>
</span>
</dt>
<dd>
<p>Path where the package is installed.</p>
<p>type: keyword</p>
<p>example: /usr/local/Cellar/go/1.12.9/</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">package.reference</code></strong></span>
</span>
</dt>
<dd>
<p>Home page or reference URL of the software in this package, if available.</p>
<p>type: keyword</p>
<p>example: <a href="https://golang.org" class="ulink" target="_top">https://golang.org</a></p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">package.size</code></strong></span>
</span>
</dt>
<dd>
<p>Package size in bytes.</p>
<p>type: long</p>
<p>example: 62231</p>
<p>format: string</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">package.type</code></strong></span>
</span>
</dt>
<dd>
<p>Type of package.
This should contain the package file type, rather than the package manager name. Examples: rpm, dpkg, brew, npm, gem, nupkg, jar.</p>
<p>type: keyword</p>
<p>example: rpm</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">package.version</code></strong></span>
</span>
</dt>
<dd>
<p>Package version</p>
<p>type: keyword</p>
<p>example: 1.12.9</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_pe"></a>pe</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.7/docs/fields.asciidoc">edit</a></div>
<p>These fields contain Windows Portable Executable (PE) metadata.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">pe.company</code></strong></span>
</span>
</dt>
<dd>
<p>Internal company name of the file, provided at compile-time.</p>
<p>type: keyword</p>
<p>example: Microsoft Corporation</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">pe.description</code></strong></span>
</span>
</dt>
<dd>
<p>Internal description of the file, provided at compile-time.</p>
<p>type: keyword</p>
<p>example: Paint</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">pe.file_version</code></strong></span>
</span>
</dt>
<dd>
<p>Internal version of the file, provided at compile-time.</p>
<p>type: keyword</p>
<p>example: 6.3.9600.17415</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">pe.original_file_name</code></strong></span>
</span>
</dt>
<dd>
<p>Internal name of the file, provided at compile-time.</p>
<p>type: keyword</p>
<p>example: MSPAINT.EXE</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">pe.product</code></strong></span>
</span>
</dt>
<dd>
<p>Internal product name of the file, provided at compile-time.</p>
<p>type: keyword</p>
<p>example: Microsoft® Windows® Operating System</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_process_2"></a>process</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.7/docs/fields.asciidoc">edit</a></div>
<p>These fields contain information about a process.
These fields can help you correlate metrics information with a process id/name from a log message.  The <code class="literal">process.pid</code> often stays in the metric itself and is copied to the global field for correlation.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.args</code></strong></span>
</span>
</dt>
<dd>
<p>Array of process arguments, starting with the absolute path to the executable.
May be filtered to protect sensitive information.</p>
<p>type: keyword</p>
<p>example: [<em>/usr/bin/ssh</em>, <em>-l</em>, <em>user</em>, <em>10.0.0.16</em>]</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.args_count</code></strong></span>
</span>
</dt>
<dd>
<p>Length of the process.args array.
This field can be useful for querying or performing bucket analysis on how many arguments were provided to start a process. More arguments may be an indication of suspicious activity.</p>
<p>type: long</p>
<p>example: 4</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.code_signature.exists</code></strong></span>
</span>
</dt>
<dd>
<p>Boolean to capture if a signature is present.</p>
<p>type: boolean</p>
<p>example: true</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.code_signature.status</code></strong></span>
</span>
</dt>
<dd>
<p>Additional information about the certificate status.
This is useful for logging cryptographic errors with the certificate validity or trust status. Leave unpopulated if the validity or trust of the certificate was unchecked.</p>
<p>type: keyword</p>
<p>example: ERROR_UNTRUSTED_ROOT</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.code_signature.subject_name</code></strong></span>
</span>
</dt>
<dd>
<p>Subject name of the code signer</p>
<p>type: keyword</p>
<p>example: Microsoft Corporation</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.code_signature.trusted</code></strong></span>
</span>
</dt>
<dd>
<p>Stores the trust status of the certificate chain.
Validating the trust of the certificate chain may be complicated, and this field should only be populated by tools that actively check the status.</p>
<p>type: boolean</p>
<p>example: true</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.code_signature.valid</code></strong></span>
</span>
</dt>
<dd>
<p>Boolean to capture if the digital signature is verified against the binary content.
Leave unpopulated if a certificate was unchecked.</p>
<p>type: boolean</p>
<p>example: true</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.command_line</code></strong></span>
</span>
</dt>
<dd>
<p>Full command line that started the process, including the absolute path to the executable, and all arguments.
Some arguments may be filtered to protect sensitive information.</p>
<p>type: keyword</p>
<p>example: /usr/bin/ssh -l user 10.0.0.16</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.command_line.text</code></strong></span>
</span>
</dt>
<dd>
<p>type: text</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.entity_id</code></strong></span>
</span>
</dt>
<dd>
<p>Unique identifier for the process.
The implementation of this is specified by the data source, but some examples of what could be used here are a process-generated UUID, Sysmon Process GUIDs, or a hash of some uniquely identifying components of a process.
Constructing a globally unique identifier is a common practice to mitigate PID reuse as well as to identify a specific process over time, across multiple monitored hosts.</p>
<p>type: keyword</p>
<p>example: c2c455d9f99375d</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.executable</code></strong></span>
</span>
</dt>
<dd>
<p>Absolute path to the process executable.</p>
<p>type: keyword</p>
<p>example: /usr/bin/ssh</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.executable.text</code></strong></span>
</span>
</dt>
<dd>
<p>type: text</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.exit_code</code></strong></span>
</span>
</dt>
<dd>
<p>The exit code of the process, if this is a termination event.
The field should be absent if there is no exit code for the event (e.g. process start).</p>
<p>type: long</p>
<p>example: 137</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.hash.md5</code></strong></span>
</span>
</dt>
<dd>
<p>MD5 hash.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.hash.sha1</code></strong></span>
</span>
</dt>
<dd>
<p>SHA1 hash.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.hash.sha256</code></strong></span>
</span>
</dt>
<dd>
<p>SHA256 hash.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.hash.sha512</code></strong></span>
</span>
</dt>
<dd>
<p>SHA512 hash.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.name</code></strong></span>
</span>
</dt>
<dd>
<p>Process name.
Sometimes called program name or similar.</p>
<p>type: keyword</p>
<p>example: ssh</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.name.text</code></strong></span>
</span>
</dt>
<dd>
<p>type: text</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.parent.args</code></strong></span>
</span>
</dt>
<dd>
<p>Array of process arguments.
May be filtered to protect sensitive information.</p>
<p>type: keyword</p>
<p>example: [<em>ssh</em>, <em>-l</em>, <em>user</em>, <em>10.0.0.16</em>]</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.parent.args_count</code></strong></span>
</span>
</dt>
<dd>
<p>Length of the process.args array.
This field can be useful for querying or performing bucket analysis on how many arguments were provided to start a process. More arguments may be an indication of suspicious activity.</p>
<p>type: long</p>
<p>example: 4</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.parent.code_signature.exists</code></strong></span>
</span>
</dt>
<dd>
<p>Boolean to capture if a signature is present.</p>
<p>type: boolean</p>
<p>example: true</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.parent.code_signature.status</code></strong></span>
</span>
</dt>
<dd>
<p>Additional information about the certificate status.
This is useful for logging cryptographic errors with the certificate validity or trust status. Leave unpopulated if the validity or trust of the certificate was unchecked.</p>
<p>type: keyword</p>
<p>example: ERROR_UNTRUSTED_ROOT</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.parent.code_signature.subject_name</code></strong></span>
</span>
</dt>
<dd>
<p>Subject name of the code signer</p>
<p>type: keyword</p>
<p>example: Microsoft Corporation</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.parent.code_signature.trusted</code></strong></span>
</span>
</dt>
<dd>
<p>Stores the trust status of the certificate chain.
Validating the trust of the certificate chain may be complicated, and this field should only be populated by tools that actively check the status.</p>
<p>type: boolean</p>
<p>example: true</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.parent.code_signature.valid</code></strong></span>
</span>
</dt>
<dd>
<p>Boolean to capture if the digital signature is verified against the binary content.
Leave unpopulated if a certificate was unchecked.</p>
<p>type: boolean</p>
<p>example: true</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.parent.command_line</code></strong></span>
</span>
</dt>
<dd>
<p>Full command line that started the process, including the absolute path to the executable, and all arguments.
Some arguments may be filtered to protect sensitive information.</p>
<p>type: keyword</p>
<p>example: /usr/bin/ssh -l user 10.0.0.16</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.parent.command_line.text</code></strong></span>
</span>
</dt>
<dd>
<p>type: text</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.parent.entity_id</code></strong></span>
</span>
</dt>
<dd>
<p>Unique identifier for the process.
The implementation of this is specified by the data source, but some examples of what could be used here are a process-generated UUID, Sysmon Process GUIDs, or a hash of some uniquely identifying components of a process.
Constructing a globally unique identifier is a common practice to mitigate PID reuse as well as to identify a specific process over time, across multiple monitored hosts.</p>
<p>type: keyword</p>
<p>example: c2c455d9f99375d</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.parent.executable</code></strong></span>
</span>
</dt>
<dd>
<p>Absolute path to the process executable.</p>
<p>type: keyword</p>
<p>example: /usr/bin/ssh</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.parent.executable.text</code></strong></span>
</span>
</dt>
<dd>
<p>type: text</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.parent.exit_code</code></strong></span>
</span>
</dt>
<dd>
<p>The exit code of the process, if this is a termination event.
The field should be absent if there is no exit code for the event (e.g. process start).</p>
<p>type: long</p>
<p>example: 137</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.parent.hash.md5</code></strong></span>
</span>
</dt>
<dd>
<p>MD5 hash.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.parent.hash.sha1</code></strong></span>
</span>
</dt>
<dd>
<p>SHA1 hash.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.parent.hash.sha256</code></strong></span>
</span>
</dt>
<dd>
<p>SHA256 hash.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.parent.hash.sha512</code></strong></span>
</span>
</dt>
<dd>
<p>SHA512 hash.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.parent.name</code></strong></span>
</span>
</dt>
<dd>
<p>Process name.
Sometimes called program name or similar.</p>
<p>type: keyword</p>
<p>example: ssh</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.parent.name.text</code></strong></span>
</span>
</dt>
<dd>
<p>type: text</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.parent.pgid</code></strong></span>
</span>
</dt>
<dd>
<p>Identifier of the group of processes the process belongs to.</p>
<p>type: long</p>
<p>format: string</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.parent.pid</code></strong></span>
</span>
</dt>
<dd>
<p>Process id.</p>
<p>type: long</p>
<p>example: 4242</p>
<p>format: string</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.parent.ppid</code></strong></span>
</span>
</dt>
<dd>
<p>Parent process' pid.</p>
<p>type: long</p>
<p>example: 4241</p>
<p>format: string</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.parent.start</code></strong></span>
</span>
</dt>
<dd>
<p>The time the process started.</p>
<p>type: date</p>
<p>example: 2016-05-23T08:05:34.853Z</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.parent.thread.id</code></strong></span>
</span>
</dt>
<dd>
<p>Thread ID.</p>
<p>type: long</p>
<p>example: 4242</p>
<p>format: string</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.parent.thread.name</code></strong></span>
</span>
</dt>
<dd>
<p>Thread name.</p>
<p>type: keyword</p>
<p>example: thread-0</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.parent.title</code></strong></span>
</span>
</dt>
<dd>
<p>Process title.
The proctitle, some times the same as process name. Can also be different: for example a browser setting its title to the web page currently opened.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.parent.title.text</code></strong></span>
</span>
</dt>
<dd>
<p>type: text</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.parent.uptime</code></strong></span>
</span>
</dt>
<dd>
<p>Seconds the process has been up.</p>
<p>type: long</p>
<p>example: 1325</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.parent.working_directory</code></strong></span>
</span>
</dt>
<dd>
<p>The working directory of the process.</p>
<p>type: keyword</p>
<p>example: /home/alice</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.parent.working_directory.text</code></strong></span>
</span>
</dt>
<dd>
<p>type: text</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.pe.company</code></strong></span>
</span>
</dt>
<dd>
<p>Internal company name of the file, provided at compile-time.</p>
<p>type: keyword</p>
<p>example: Microsoft Corporation</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.pe.description</code></strong></span>
</span>
</dt>
<dd>
<p>Internal description of the file, provided at compile-time.</p>
<p>type: keyword</p>
<p>example: Paint</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.pe.file_version</code></strong></span>
</span>
</dt>
<dd>
<p>Internal version of the file, provided at compile-time.</p>
<p>type: keyword</p>
<p>example: 6.3.9600.17415</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.pe.original_file_name</code></strong></span>
</span>
</dt>
<dd>
<p>Internal name of the file, provided at compile-time.</p>
<p>type: keyword</p>
<p>example: MSPAINT.EXE</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.pe.product</code></strong></span>
</span>
</dt>
<dd>
<p>Internal product name of the file, provided at compile-time.</p>
<p>type: keyword</p>
<p>example: Microsoft® Windows® Operating System</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.pgid</code></strong></span>
</span>
</dt>
<dd>
<p>Identifier of the group of processes the process belongs to.</p>
<p>type: long</p>
<p>format: string</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.pid</code></strong></span>
</span>
</dt>
<dd>
<p>Process id.</p>
<p>type: long</p>
<p>example: 4242</p>
<p>format: string</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.ppid</code></strong></span>
</span>
</dt>
<dd>
<p>Parent process' pid.</p>
<p>type: long</p>
<p>example: 4241</p>
<p>format: string</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.start</code></strong></span>
</span>
</dt>
<dd>
<p>The time the process started.</p>
<p>type: date</p>
<p>example: 2016-05-23T08:05:34.853Z</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.thread.id</code></strong></span>
</span>
</dt>
<dd>
<p>Thread ID.</p>
<p>type: long</p>
<p>example: 4242</p>
<p>format: string</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.thread.name</code></strong></span>
</span>
</dt>
<dd>
<p>Thread name.</p>
<p>type: keyword</p>
<p>example: thread-0</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.title</code></strong></span>
</span>
</dt>
<dd>
<p>Process title.
The proctitle, some times the same as process name. Can also be different: for example a browser setting its title to the web page currently opened.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.title.text</code></strong></span>
</span>
</dt>
<dd>
<p>type: text</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.uptime</code></strong></span>
</span>
</dt>
<dd>
<p>Seconds the process has been up.</p>
<p>type: long</p>
<p>example: 1325</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.working_directory</code></strong></span>
</span>
</dt>
<dd>
<p>The working directory of the process.</p>
<p>type: keyword</p>
<p>example: /home/alice</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">process.working_directory.text</code></strong></span>
</span>
</dt>
<dd>
<p>type: text</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_registry"></a>registry</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.7/docs/fields.asciidoc">edit</a></div>
<p>Fields related to Windows Registry operations.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">registry.data.bytes</code></strong></span>
</span>
</dt>
<dd>
<p>Original bytes written with base64 encoding.
For Windows registry operations, such as SetValueEx and RegQueryValueEx, this corresponds to the data pointed by <code class="literal">lp_data</code>. This is optional but provides better recoverability and should be populated for REG_BINARY encoded values.</p>
<p>type: keyword</p>
<p>example: ZQBuAC0AVQBTAAAAZQBuAAAAAAA=</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">registry.data.strings</code></strong></span>
</span>
</dt>
<dd>
<p>Content when writing string types.
Populated as an array when writing string data to the registry. For single string registry types (REG_SZ, REG_EXPAND_SZ), this should be an array with one string. For sequences of string with REG_MULTI_SZ, this array will be variable length. For numeric data, such as REG_DWORD and REG_QWORD, this should be populated with the decimal representation (e.g <code class="literal">"1"</code>).</p>
<p>type: keyword</p>
<p>example: ["C:\rta\red_ttp\bin\myapp.exe"]</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">registry.data.type</code></strong></span>
</span>
</dt>
<dd>
<p>Standard registry type for encoding contents</p>
<p>type: keyword</p>
<p>example: REG_SZ</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">registry.hive</code></strong></span>
</span>
</dt>
<dd>
<p>Abbreviated name for the hive.</p>
<p>type: keyword</p>
<p>example: HKLM</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">registry.key</code></strong></span>
</span>
</dt>
<dd>
<p>Hive-relative path of keys.</p>
<p>type: keyword</p>
<p>example: SOFTWARE\Microsoft\Windows NT\CurrentVersion\Image File Execution Options\winword.exe</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">registry.path</code></strong></span>
</span>
</dt>
<dd>
<p>Full path, including hive, key and value</p>
<p>type: keyword</p>
<p>example: HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Image File Execution Options\winword.exe\Debugger</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">registry.value</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the value written.</p>
<p>type: keyword</p>
<p>example: Debugger</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_related"></a>related</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.7/docs/fields.asciidoc">edit</a></div>
<p>This field set is meant to facilitate pivoting around a piece of data.
Some pieces of information can be seen in many places in an ECS event. To facilitate searching for them, store an array of all seen values to their corresponding field in <code class="literal">related.</code>.
A concrete example is IP addresses, which can be under host, observer, source, destination, client, server, and network.forwarded_ip. If you append all IPs to <code class="literal">related.ip</code>, you can then search for a given IP trivially, no matter where it appeared, by querying <code class="literal">related.ip:192.0.2.15</code>.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">related.hash</code></strong></span>
</span>
</dt>
<dd>
<p>All the hashes seen on your event. Populating this field, then using it to search for hashes can help in situations where you&#8217;re unsure what the hash algorithm is (and therefore which key name to search).</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">related.ip</code></strong></span>
</span>
</dt>
<dd>
<p>All of the IPs seen on your event.</p>
<p>type: ip</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">related.user</code></strong></span>
</span>
</dt>
<dd>
<p>All the user names seen on your event.</p>
<p>type: keyword</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_rule"></a>rule</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.7/docs/fields.asciidoc">edit</a></div>
<p>Rule fields are used to capture the specifics of any observer or agent rules that generate alerts or other notable events.
Examples of data sources that would populate the rule fields include: network admission control platforms, network or host IDS/IPS, network firewalls, web application firewalls, url filters, endpoint detection and response (EDR) systems, etc.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">rule.author</code></strong></span>
</span>
</dt>
<dd>
<p>Name, organization, or pseudonym of the author or authors who created the rule used to generate this event.</p>
<p>type: keyword</p>
<p>example: [<em>Star-Lord</em>]</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">rule.category</code></strong></span>
</span>
</dt>
<dd>
<p>A categorization value keyword used by the entity using the rule for detection of this event.</p>
<p>type: keyword</p>
<p>example: Attempted Information Leak</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">rule.description</code></strong></span>
</span>
</dt>
<dd>
<p>The description of the rule generating the event.</p>
<p>type: keyword</p>
<p>example: Block requests to public DNS over HTTPS / TLS protocols</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">rule.id</code></strong></span>
</span>
</dt>
<dd>
<p>A rule ID that is unique within the scope of an agent, observer, or other entity using the rule for detection of this event.</p>
<p>type: keyword</p>
<p>example: 101</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">rule.license</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the license under which the rule used to generate this event is made available.</p>
<p>type: keyword</p>
<p>example: Apache 2.0</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">rule.name</code></strong></span>
</span>
</dt>
<dd>
<p>The name of the rule or signature generating the event.</p>
<p>type: keyword</p>
<p>example: BLOCK_DNS_over_TLS</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">rule.reference</code></strong></span>
</span>
</dt>
<dd>
<p>Reference URL to additional information about the rule used to generate this event.
The URL can point to the vendor&#8217;s documentation about the rule. If that&#8217;s not available, it can also be a link to a more general page describing this type of alert.</p>
<p>type: keyword</p>
<p>example: <a href="https://en.wikipedia.org/wiki/DNS_over_TLS" class="ulink" target="_top">https://en.wikipedia.org/wiki/DNS_over_TLS</a></p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">rule.ruleset</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the ruleset, policy, group, or parent category in which the rule used to generate this event is a member.</p>
<p>type: keyword</p>
<p>example: Standard_Protocol_Filters</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">rule.uuid</code></strong></span>
</span>
</dt>
<dd>
<p>A rule ID that is unique within the scope of a set or group of agents, observers, or other entities using the rule for detection of this event.</p>
<p>type: keyword</p>
<p>example: 1100110011</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">rule.version</code></strong></span>
</span>
</dt>
<dd>
<p>The version / revision of the rule being used for analysis.</p>
<p>type: keyword</p>
<p>example: 1.1</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_server"></a>server</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.7/docs/fields.asciidoc">edit</a></div>
<p>A Server is defined as the responder in a network connection for events regarding sessions, connections, or bidirectional flow records.
For TCP events, the server is the receiver of the initial SYN packet(s) of the TCP connection. For other protocols, the server is generally the responder in the network transaction. Some systems actually use the term "responder" to refer the server in TCP connections. The server fields describe details about the system acting as the server in the network event. Server fields are usually populated in conjunction with client fields. Server fields are generally not populated for packet-level events.
Client / server representations can add semantic context to an exchange, which is helpful to visualize the data in certain situations. If your context falls in that category, you should still ensure that source and destination are filled appropriately.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">server.address</code></strong></span>
</span>
</dt>
<dd>
<p>Some event server addresses are defined ambiguously. The event will sometimes list an IP, a domain or a unix socket.  You should always store the raw address in the <code class="literal">.address</code> field.
Then it should be duplicated to <code class="literal">.ip</code> or <code class="literal">.domain</code>, depending on which one it is.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">server.as.number</code></strong></span>
</span>
</dt>
<dd>
<p>Unique number allocated to the autonomous system. The autonomous system number (ASN) uniquely identifies each network on the Internet.</p>
<p>type: long</p>
<p>example: 15169</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">server.as.organization.name</code></strong></span>
</span>
</dt>
<dd>
<p>Organization name.</p>
<p>type: keyword</p>
<p>example: Google LLC</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">server.as.organization.name.text</code></strong></span>
</span>
</dt>
<dd>
<p>type: text</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">server.bytes</code></strong></span>
</span>
</dt>
<dd>
<p>Bytes sent from the server to the client.</p>
<p>type: long</p>
<p>example: 184</p>
<p>format: bytes</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">server.domain</code></strong></span>
</span>
</dt>
<dd>
<p>Server domain.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">server.geo.city_name</code></strong></span>
</span>
</dt>
<dd>
<p>City name.</p>
<p>type: keyword</p>
<p>example: Montreal</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">server.geo.continent_name</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the continent.</p>
<p>type: keyword</p>
<p>example: North America</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">server.geo.country_iso_code</code></strong></span>
</span>
</dt>
<dd>
<p>Country ISO code.</p>
<p>type: keyword</p>
<p>example: CA</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">server.geo.country_name</code></strong></span>
</span>
</dt>
<dd>
<p>Country name.</p>
<p>type: keyword</p>
<p>example: Canada</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">server.geo.location</code></strong></span>
</span>
</dt>
<dd>
<p>Longitude and latitude.</p>
<p>type: geo_point</p>
<p>example: { "lon": -73.614830, "lat": 45.505918 }</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">server.geo.name</code></strong></span>
</span>
</dt>
<dd>
<p>User-defined description of a location, at the level of granularity they care about.
Could be the name of their data centers, the floor number, if this describes a local physical entity, city names.
Not typically used in automated geolocation.</p>
<p>type: keyword</p>
<p>example: boston-dc</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">server.geo.region_iso_code</code></strong></span>
</span>
</dt>
<dd>
<p>Region ISO code.</p>
<p>type: keyword</p>
<p>example: CA-QC</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">server.geo.region_name</code></strong></span>
</span>
</dt>
<dd>
<p>Region name.</p>
<p>type: keyword</p>
<p>example: Quebec</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">server.ip</code></strong></span>
</span>
</dt>
<dd>
<p>IP address of the server.
Can be one or multiple IPv4 or IPv6 addresses.</p>
<p>type: ip</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">server.mac</code></strong></span>
</span>
</dt>
<dd>
<p>MAC address of the server.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">server.nat.ip</code></strong></span>
</span>
</dt>
<dd>
<p>Translated ip of destination based NAT sessions (e.g. internet to private DMZ)
Typically used with load balancers, firewalls, or routers.</p>
<p>type: ip</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">server.nat.port</code></strong></span>
</span>
</dt>
<dd>
<p>Translated port of destination based NAT sessions (e.g. internet to private DMZ)
Typically used with load balancers, firewalls, or routers.</p>
<p>type: long</p>
<p>format: string</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">server.packets</code></strong></span>
</span>
</dt>
<dd>
<p>Packets sent from the server to the client.</p>
<p>type: long</p>
<p>example: 12</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">server.port</code></strong></span>
</span>
</dt>
<dd>
<p>Port of the server.</p>
<p>type: long</p>
<p>format: string</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">server.registered_domain</code></strong></span>
</span>
</dt>
<dd>
<p>The highest registered server 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 (<a href="http://publicsuffix.org" class="ulink" target="_top">http://publicsuffix.org</a>). Trying to approximate this by simply taking the last two labels will not work well for TLDs such as "co.uk".</p>
<p>type: keyword</p>
<p>example: google.com</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">server.top_level_domain</code></strong></span>
</span>
</dt>
<dd>
<p>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 (<a href="http://publicsuffix.org" class="ulink" target="_top">http://publicsuffix.org</a>). Trying to approximate this by simply taking the last label will not work well for effective TLDs such as "co.uk".</p>
<p>type: keyword</p>
<p>example: co.uk</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">server.user.domain</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the directory the user is a member of.
For example, an LDAP or Active Directory domain name.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">server.user.email</code></strong></span>
</span>
</dt>
<dd>
<p>User email address.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">server.user.full_name</code></strong></span>
</span>
</dt>
<dd>
<p>User&#8217;s full name, if available.</p>
<p>type: keyword</p>
<p>example: Albert Einstein</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">server.user.full_name.text</code></strong></span>
</span>
</dt>
<dd>
<p>type: text</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">server.user.group.domain</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the directory the group is a member of.
For example, an LDAP or Active Directory domain name.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">server.user.group.id</code></strong></span>
</span>
</dt>
<dd>
<p>Unique identifier for the group on the system/platform.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">server.user.group.name</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the group.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">server.user.hash</code></strong></span>
</span>
</dt>
<dd>
<p>Unique user hash to correlate information for a user in anonymized form.
Useful if <code class="literal">user.id</code> or <code class="literal">user.name</code> contain confidential information and cannot be used.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">server.user.id</code></strong></span>
</span>
</dt>
<dd>
<p>Unique identifiers of the user.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">server.user.name</code></strong></span>
</span>
</dt>
<dd>
<p>Short name or login of the user.</p>
<p>type: keyword</p>
<p>example: albert</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">server.user.name.text</code></strong></span>
</span>
</dt>
<dd>
<p>type: text</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_service_4"></a>service</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.7/docs/fields.asciidoc">edit</a></div>
<p>The service fields describe the service for or from which the data was collected.
These fields help you find and correlate logs for a specific service and version.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">service.ephemeral_id</code></strong></span>
</span>
</dt>
<dd>
<p>Ephemeral identifier of this service (if one exists).
This id normally changes across restarts, but <code class="literal">service.id</code> does not.</p>
<p>type: keyword</p>
<p>example: 8a4f500f</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">service.id</code></strong></span>
</span>
</dt>
<dd>
<p>Unique identifier of the running service. If the service is comprised of many nodes, the <code class="literal">service.id</code> should be the same for all nodes.
This id should uniquely identify the service. This makes it possible to correlate logs and metrics for one specific service, no matter which particular node emitted the event.
Note that if you need to see the events from one specific host of the service, you should filter on that <code class="literal">host.name</code> or <code class="literal">host.id</code> instead.</p>
<p>type: keyword</p>
<p>example: d37e5ebfe0ae6c4972dbe9f0174a1637bb8247f6</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">service.name</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the service data is collected from.
The name of the service is normally user given. This allows for distributed services that run on multiple hosts to correlate the related instances based on the name.
In the case of Elasticsearch the <code class="literal">service.name</code> could contain the cluster name. For Beats the <code class="literal">service.name</code> is by default a copy of the <code class="literal">service.type</code> field if no name is specified.</p>
<p>type: keyword</p>
<p>example: elasticsearch-metrics</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">service.node.name</code></strong></span>
</span>
</dt>
<dd>
<p>Name of a service node.
This allows for two nodes of the same service running on the same host to be differentiated. Therefore, <code class="literal">service.node.name</code> should typically be unique across nodes of a given service.
In the case of Elasticsearch, the <code class="literal">service.node.name</code> could contain the unique node name within the Elasticsearch cluster. In cases where the service doesn&#8217;t have the concept of a node name, the host name or container name can be used to distinguish running instances that make up this service. If those do not provide uniqueness (e.g. multiple instances of the service running on the same host) - the node name can be manually set.</p>
<p>type: keyword</p>
<p>example: instance-0000000016</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">service.state</code></strong></span>
</span>
</dt>
<dd>
<p>Current state of the service.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">service.type</code></strong></span>
</span>
</dt>
<dd>
<p>The type of the service data is collected from.
The type can be used to group and correlate logs and metrics from one service type.
Example: If logs or metrics are collected from Elasticsearch, <code class="literal">service.type</code> would be <code class="literal">elasticsearch</code>.</p>
<p>type: keyword</p>
<p>example: elasticsearch</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">service.version</code></strong></span>
</span>
</dt>
<dd>
<p>Version of the service the data was collected from.
This allows to look at a data set only for a specific version of a service.</p>
<p>type: keyword</p>
<p>example: 3.2.4</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_source"></a>source</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.7/docs/fields.asciidoc">edit</a></div>
<p>Source fields describe details about the source of a packet/event.
Source fields are usually populated in conjunction with destination fields.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">source.address</code></strong></span>
</span>
</dt>
<dd>
<p>Some event source addresses are defined ambiguously. The event will sometimes list an IP, a domain or a unix socket.  You should always store the raw address in the <code class="literal">.address</code> field.
Then it should be duplicated to <code class="literal">.ip</code> or <code class="literal">.domain</code>, depending on which one it is.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">source.as.number</code></strong></span>
</span>
</dt>
<dd>
<p>Unique number allocated to the autonomous system. The autonomous system number (ASN) uniquely identifies each network on the Internet.</p>
<p>type: long</p>
<p>example: 15169</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">source.as.organization.name</code></strong></span>
</span>
</dt>
<dd>
<p>Organization name.</p>
<p>type: keyword</p>
<p>example: Google LLC</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">source.as.organization.name.text</code></strong></span>
</span>
</dt>
<dd>
<p>type: text</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">source.bytes</code></strong></span>
</span>
</dt>
<dd>
<p>Bytes sent from the source to the destination.</p>
<p>type: long</p>
<p>example: 184</p>
<p>format: bytes</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">source.domain</code></strong></span>
</span>
</dt>
<dd>
<p>Source domain.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">source.geo.city_name</code></strong></span>
</span>
</dt>
<dd>
<p>City name.</p>
<p>type: keyword</p>
<p>example: Montreal</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">source.geo.continent_name</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the continent.</p>
<p>type: keyword</p>
<p>example: North America</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">source.geo.country_iso_code</code></strong></span>
</span>
</dt>
<dd>
<p>Country ISO code.</p>
<p>type: keyword</p>
<p>example: CA</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">source.geo.country_name</code></strong></span>
</span>
</dt>
<dd>
<p>Country name.</p>
<p>type: keyword</p>
<p>example: Canada</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">source.geo.location</code></strong></span>
</span>
</dt>
<dd>
<p>Longitude and latitude.</p>
<p>type: geo_point</p>
<p>example: { "lon": -73.614830, "lat": 45.505918 }</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">source.geo.name</code></strong></span>
</span>
</dt>
<dd>
<p>User-defined description of a location, at the level of granularity they care about.
Could be the name of their data centers, the floor number, if this describes a local physical entity, city names.
Not typically used in automated geolocation.</p>
<p>type: keyword</p>
<p>example: boston-dc</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">source.geo.region_iso_code</code></strong></span>
</span>
</dt>
<dd>
<p>Region ISO code.</p>
<p>type: keyword</p>
<p>example: CA-QC</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">source.geo.region_name</code></strong></span>
</span>
</dt>
<dd>
<p>Region name.</p>
<p>type: keyword</p>
<p>example: Quebec</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">source.ip</code></strong></span>
</span>
</dt>
<dd>
<p>IP address of the source.
Can be one or multiple IPv4 or IPv6 addresses.</p>
<p>type: ip</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">source.mac</code></strong></span>
</span>
</dt>
<dd>
<p>MAC address of the source.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">source.nat.ip</code></strong></span>
</span>
</dt>
<dd>
<p>Translated ip of source based NAT sessions (e.g. internal client to internet)
Typically connections traversing load balancers, firewalls, or routers.</p>
<p>type: ip</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">source.nat.port</code></strong></span>
</span>
</dt>
<dd>
<p>Translated port of source based NAT sessions. (e.g. internal client to internet)
Typically used with load balancers, firewalls, or routers.</p>
<p>type: long</p>
<p>format: string</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">source.packets</code></strong></span>
</span>
</dt>
<dd>
<p>Packets sent from the source to the destination.</p>
<p>type: long</p>
<p>example: 12</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">source.port</code></strong></span>
</span>
</dt>
<dd>
<p>Port of the source.</p>
<p>type: long</p>
<p>format: string</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">source.registered_domain</code></strong></span>
</span>
</dt>
<dd>
<p>The highest registered source 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 (<a href="http://publicsuffix.org" class="ulink" target="_top">http://publicsuffix.org</a>). Trying to approximate this by simply taking the last two labels will not work well for TLDs such as "co.uk".</p>
<p>type: keyword</p>
<p>example: google.com</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">source.top_level_domain</code></strong></span>
</span>
</dt>
<dd>
<p>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 (<a href="http://publicsuffix.org" class="ulink" target="_top">http://publicsuffix.org</a>). Trying to approximate this by simply taking the last label will not work well for effective TLDs such as "co.uk".</p>
<p>type: keyword</p>
<p>example: co.uk</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">source.user.domain</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the directory the user is a member of.
For example, an LDAP or Active Directory domain name.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">source.user.email</code></strong></span>
</span>
</dt>
<dd>
<p>User email address.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">source.user.full_name</code></strong></span>
</span>
</dt>
<dd>
<p>User&#8217;s full name, if available.</p>
<p>type: keyword</p>
<p>example: Albert Einstein</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">source.user.full_name.text</code></strong></span>
</span>
</dt>
<dd>
<p>type: text</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">source.user.group.domain</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the directory the group is a member of.
For example, an LDAP or Active Directory domain name.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">source.user.group.id</code></strong></span>
</span>
</dt>
<dd>
<p>Unique identifier for the group on the system/platform.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">source.user.group.name</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the group.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">source.user.hash</code></strong></span>
</span>
</dt>
<dd>
<p>Unique user hash to correlate information for a user in anonymized form.
Useful if <code class="literal">user.id</code> or <code class="literal">user.name</code> contain confidential information and cannot be used.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">source.user.id</code></strong></span>
</span>
</dt>
<dd>
<p>Unique identifiers of the user.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">source.user.name</code></strong></span>
</span>
</dt>
<dd>
<p>Short name or login of the user.</p>
<p>type: keyword</p>
<p>example: albert</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">source.user.name.text</code></strong></span>
</span>
</dt>
<dd>
<p>type: text</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_threat"></a>threat</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.7/docs/fields.asciidoc">edit</a></div>
<p>Fields to classify events and alerts according to a threat taxonomy such as the Mitre ATT&amp;CK framework.
These fields are for users to classify alerts from all of their sources (e.g. IDS, NGFW, etc.) within a common taxonomy. The threat.tactic.* are meant to capture the high level category of the threat (e.g. "impact"). The threat.technique.* fields are meant to capture which kind of approach is used by this detected threat, to accomplish the goal (e.g. "endpoint denial of service").</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">threat.framework</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the threat framework used to further categorize and classify the tactic and technique of the reported threat. Framework classification can be provided by detecting systems, evaluated at ingest time, or retrospectively tagged to events.</p>
<p>type: keyword</p>
<p>example: MITRE ATT&amp;CK</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">threat.tactic.id</code></strong></span>
</span>
</dt>
<dd>
<p>The id of tactic used by this threat. You can use the Mitre ATT&amp;CK Matrix Tactic categorization, for example. (ex. <a href="https://attack.mitre.org/tactics/TA0040/" class="ulink" target="_top">https://attack.mitre.org/tactics/TA0040/</a> )</p>
<p>type: keyword</p>
<p>example: TA0040</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">threat.tactic.name</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the type of tactic used by this threat. You can use the Mitre ATT&amp;CK Matrix Tactic categorization, for example. (ex. <a href="https://attack.mitre.org/tactics/TA0040/" class="ulink" target="_top">https://attack.mitre.org/tactics/TA0040/</a> )</p>
<p>type: keyword</p>
<p>example: impact</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">threat.tactic.reference</code></strong></span>
</span>
</dt>
<dd>
<p>The reference url of tactic used by this threat. You can use the Mitre ATT&amp;CK Matrix Tactic categorization, for example. (ex. <a href="https://attack.mitre.org/tactics/TA0040/" class="ulink" target="_top">https://attack.mitre.org/tactics/TA0040/</a> )</p>
<p>type: keyword</p>
<p>example: <a href="https://attack.mitre.org/tactics/TA0040/" class="ulink" target="_top">https://attack.mitre.org/tactics/TA0040/</a></p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">threat.technique.id</code></strong></span>
</span>
</dt>
<dd>
<p>The id of technique used by this tactic. You can use the Mitre ATT&amp;CK Matrix Tactic categorization, for example. (ex. <a href="https://attack.mitre.org/techniques/T1499/" class="ulink" target="_top">https://attack.mitre.org/techniques/T1499/</a> )</p>
<p>type: keyword</p>
<p>example: T1499</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">threat.technique.name</code></strong></span>
</span>
</dt>
<dd>
<p>The name of technique used by this tactic. You can use the Mitre ATT&amp;CK Matrix Tactic categorization, for example. (ex. <a href="https://attack.mitre.org/techniques/T1499/" class="ulink" target="_top">https://attack.mitre.org/techniques/T1499/</a> )</p>
<p>type: keyword</p>
<p>example: endpoint denial of service</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">threat.technique.name.text</code></strong></span>
</span>
</dt>
<dd>
<p>type: text</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">threat.technique.reference</code></strong></span>
</span>
</dt>
<dd>
<p>The reference url of technique used by this tactic. You can use the Mitre ATT&amp;CK Matrix Tactic categorization, for example. (ex. <a href="https://attack.mitre.org/techniques/T1499/" class="ulink" target="_top">https://attack.mitre.org/techniques/T1499/</a> )</p>
<p>type: keyword</p>
<p>example: <a href="https://attack.mitre.org/techniques/T1499/" class="ulink" target="_top">https://attack.mitre.org/techniques/T1499/</a></p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_tls"></a>tls</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.7/docs/fields.asciidoc">edit</a></div>
<p>Fields related to a TLS connection. These fields focus on the TLS protocol itself and intentionally avoids in-depth analysis of the related x.509 certificate files.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">tls.cipher</code></strong></span>
</span>
</dt>
<dd>
<p>String indicating the cipher used during the current connection.</p>
<p>type: keyword</p>
<p>example: TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">tls.client.certificate</code></strong></span>
</span>
</dt>
<dd>
<p>PEM-encoded stand-alone certificate offered by the client. This is usually mutually-exclusive of <code class="literal">client.certificate_chain</code> since this value also exists in that list.</p>
<p>type: keyword</p>
<p>example: MII&#8230;&#8203;</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">tls.client.certificate_chain</code></strong></span>
</span>
</dt>
<dd>
<p>Array of PEM-encoded certificates that make up the certificate chain offered by the client. This is usually mutually-exclusive of <code class="literal">client.certificate</code> since that value should be the first certificate in the chain.</p>
<p>type: keyword</p>
<p>example: [<em>MII&#8230;&#8203;</em>, <em>MII&#8230;&#8203;</em>]</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">tls.client.hash.md5</code></strong></span>
</span>
</dt>
<dd>
<p>Certificate fingerprint using the MD5 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash.</p>
<p>type: keyword</p>
<p>example: 0F76C7F2C55BFD7D8E8B8F4BFBF0C9EC</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">tls.client.hash.sha1</code></strong></span>
</span>
</dt>
<dd>
<p>Certificate fingerprint using the SHA1 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash.</p>
<p>type: keyword</p>
<p>example: 9E393D93138888D288266C2D915214D1D1CCEB2A</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">tls.client.hash.sha256</code></strong></span>
</span>
</dt>
<dd>
<p>Certificate fingerprint using the SHA256 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash.</p>
<p>type: keyword</p>
<p>example: 0687F666A054EF17A08E2F2162EAB4CBC0D265E1D7875BE74BF3C712CA92DAF0</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">tls.client.issuer</code></strong></span>
</span>
</dt>
<dd>
<p>Distinguished name of subject of the issuer of the x.509 certificate presented by the client.</p>
<p>type: keyword</p>
<p>example: CN=MyDomain Root CA, OU=Infrastructure Team, DC=mydomain, DC=com</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">tls.client.ja3</code></strong></span>
</span>
</dt>
<dd>
<p>A hash that identifies clients based on how they perform an SSL/TLS handshake.</p>
<p>type: keyword</p>
<p>example: d4e5b18d6b55c71272893221c96ba240</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">tls.client.not_after</code></strong></span>
</span>
</dt>
<dd>
<p>Date/Time indicating when client certificate is no longer considered valid.</p>
<p>type: date</p>
<p>example: 2021-01-01T00:00:00.000Z</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">tls.client.not_before</code></strong></span>
</span>
</dt>
<dd>
<p>Date/Time indicating when client certificate is first considered valid.</p>
<p>type: date</p>
<p>example: 1970-01-01T00:00:00.000Z</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">tls.client.server_name</code></strong></span>
</span>
</dt>
<dd>
<p>Also called an SNI, this tells the server which hostname to which the client is attempting to connect. When this value is available, it should get copied to <code class="literal">destination.domain</code>.</p>
<p>type: keyword</p>
<p>example: www.elastic.co</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">tls.client.subject</code></strong></span>
</span>
</dt>
<dd>
<p>Distinguished name of subject of the x.509 certificate presented by the client.</p>
<p>type: keyword</p>
<p>example: CN=myclient, OU=Documentation Team, DC=mydomain, DC=com</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">tls.client.supported_ciphers</code></strong></span>
</span>
</dt>
<dd>
<p>Array of ciphers offered by the client during the client hello.</p>
<p>type: keyword</p>
<p>example: [<em>TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384</em>, <em>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</em>, <em>&#8230;&#8203;</em>]</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">tls.curve</code></strong></span>
</span>
</dt>
<dd>
<p>String indicating the curve used for the given cipher, when applicable.</p>
<p>type: keyword</p>
<p>example: secp256r1</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">tls.established</code></strong></span>
</span>
</dt>
<dd>
<p>Boolean flag indicating if the TLS negotiation was successful and transitioned to an encrypted tunnel.</p>
<p>type: boolean</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">tls.next_protocol</code></strong></span>
</span>
</dt>
<dd>
<p>String indicating the protocol being tunneled. Per the values in the IANA registry (<a href="https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids" class="ulink" target="_top">https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids</a>), this string should be lower case.</p>
<p>type: keyword</p>
<p>example: http/1.1</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">tls.resumed</code></strong></span>
</span>
</dt>
<dd>
<p>Boolean flag indicating if this TLS connection was resumed from an existing TLS negotiation.</p>
<p>type: boolean</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">tls.server.certificate</code></strong></span>
</span>
</dt>
<dd>
<p>PEM-encoded stand-alone certificate offered by the server. This is usually mutually-exclusive of <code class="literal">server.certificate_chain</code> since this value also exists in that list.</p>
<p>type: keyword</p>
<p>example: MII&#8230;&#8203;</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">tls.server.certificate_chain</code></strong></span>
</span>
</dt>
<dd>
<p>Array of PEM-encoded certificates that make up the certificate chain offered by the server. This is usually mutually-exclusive of <code class="literal">server.certificate</code> since that value should be the first certificate in the chain.</p>
<p>type: keyword</p>
<p>example: [<em>MII&#8230;&#8203;</em>, <em>MII&#8230;&#8203;</em>]</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">tls.server.hash.md5</code></strong></span>
</span>
</dt>
<dd>
<p>Certificate fingerprint using the MD5 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash.</p>
<p>type: keyword</p>
<p>example: 0F76C7F2C55BFD7D8E8B8F4BFBF0C9EC</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">tls.server.hash.sha1</code></strong></span>
</span>
</dt>
<dd>
<p>Certificate fingerprint using the SHA1 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash.</p>
<p>type: keyword</p>
<p>example: 9E393D93138888D288266C2D915214D1D1CCEB2A</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">tls.server.hash.sha256</code></strong></span>
</span>
</dt>
<dd>
<p>Certificate fingerprint using the SHA256 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash.</p>
<p>type: keyword</p>
<p>example: 0687F666A054EF17A08E2F2162EAB4CBC0D265E1D7875BE74BF3C712CA92DAF0</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">tls.server.issuer</code></strong></span>
</span>
</dt>
<dd>
<p>Subject of the issuer of the x.509 certificate presented by the server.</p>
<p>type: keyword</p>
<p>example: CN=MyDomain Root CA, OU=Infrastructure Team, DC=mydomain, DC=com</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">tls.server.ja3s</code></strong></span>
</span>
</dt>
<dd>
<p>A hash that identifies servers based on how they perform an SSL/TLS handshake.</p>
<p>type: keyword</p>
<p>example: 394441ab65754e2207b1e1b457b3641d</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">tls.server.not_after</code></strong></span>
</span>
</dt>
<dd>
<p>Timestamp indicating when server certificate is no longer considered valid.</p>
<p>type: date</p>
<p>example: 2021-01-01T00:00:00.000Z</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">tls.server.not_before</code></strong></span>
</span>
</dt>
<dd>
<p>Timestamp indicating when server certificate is first considered valid.</p>
<p>type: date</p>
<p>example: 1970-01-01T00:00:00.000Z</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">tls.server.subject</code></strong></span>
</span>
</dt>
<dd>
<p>Subject of the x.509 certificate presented by the server.</p>
<p>type: keyword</p>
<p>example: CN=www.mydomain.com, OU=Infrastructure Team, DC=mydomain, DC=com</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">tls.version</code></strong></span>
</span>
</dt>
<dd>
<p>Numeric part of the version parsed from the original string.</p>
<p>type: keyword</p>
<p>example: 1.2</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">tls.version_protocol</code></strong></span>
</span>
</dt>
<dd>
<p>Normalized lowercase protocol name parsed from original string.</p>
<p>type: keyword</p>
<p>example: tls</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_tracing"></a>tracing</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.7/docs/fields.asciidoc">edit</a></div>
<p>Distributed tracing makes it possible to analyze performance throughout a microservice architecture all in one view. This is accomplished by tracing all of the requests - from the initial web request in the front-end service - to queries made through multiple back-end services.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">tracing.trace.id</code></strong></span>
</span>
</dt>
<dd>
<p>Unique identifier of the trace.
A trace groups multiple events like transactions that belong together. For example, a user request handled by multiple inter-connected services.</p>
<p>type: keyword</p>
<p>example: 4bf92f3577b34da6a3ce929d0e0e4736</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">tracing.transaction.id</code></strong></span>
</span>
</dt>
<dd>
<p>Unique identifier of the transaction.
A transaction is the highest level of work measured within a service, such as a request to a server.</p>
<p>type: keyword</p>
<p>example: 00f067aa0ba902b7</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_url_2"></a>url</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.7/docs/fields.asciidoc">edit</a></div>
<p>URL fields provide support for complete or partial URLs, and supports the breaking down into scheme, domain, path, and so on.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">url.domain</code></strong></span>
</span>
</dt>
<dd>
<p>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 <code class="literal">domain</code> field.</p>
<p>type: keyword</p>
<p>example: www.elastic.co</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">url.extension</code></strong></span>
</span>
</dt>
<dd>
<p>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".</p>
<p>type: keyword</p>
<p>example: png</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">url.fragment</code></strong></span>
</span>
</dt>
<dd>
<p>Portion of the url after the <code class="literal">#</code>, such as "top".
The <code class="literal">#</code> is not part of the fragment.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">url.full</code></strong></span>
</span>
</dt>
<dd>
<p>If full URLs are important to your use case, they should be stored in <code class="literal">url.full</code>, whether this field is reconstructed or present in the event source.</p>
<p>type: keyword</p>
<p>example: <a href="https://www.elastic.co:443/search?q=elasticsearch#top" class="ulink" target="_top">https://www.elastic.co:443/search?q=elasticsearch#top</a></p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">url.full.text</code></strong></span>
</span>
</dt>
<dd>
<p>type: text</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">url.original</code></strong></span>
</span>
</dt>
<dd>
<p>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.</p>
<p>type: keyword</p>
<p>example: <a href="https://www.elastic.co:443/search?q=elasticsearch#top" class="ulink" target="_top">https://www.elastic.co:443/search?q=elasticsearch#top</a> or /search?q=elasticsearch</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">url.original.text</code></strong></span>
</span>
</dt>
<dd>
<p>type: text</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">url.password</code></strong></span>
</span>
</dt>
<dd>
<p>Password of the request.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">url.path</code></strong></span>
</span>
</dt>
<dd>
<p>Path of the request, such as "/search".</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">url.port</code></strong></span>
</span>
</dt>
<dd>
<p>Port of the request, such as 443.</p>
<p>type: long</p>
<p>example: 443</p>
<p>format: string</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">url.query</code></strong></span>
</span>
</dt>
<dd>
<p>The query field describes the query string of the request, such as "q=elasticsearch".
The <code class="literal">?</code> is excluded from the query string. If a URL contains no <code class="literal">?</code>, there is no query field. If there is a <code class="literal">?</code> but no query, the query field exists with an empty string. The <code class="literal">exists</code> query can be used to differentiate between the two cases.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">url.registered_domain</code></strong></span>
</span>
</dt>
<dd>
<p>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 (<a href="http://publicsuffix.org" class="ulink" target="_top">http://publicsuffix.org</a>). Trying to approximate this by simply taking the last two labels will not work well for TLDs such as "co.uk".</p>
<p>type: keyword</p>
<p>example: google.com</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">url.scheme</code></strong></span>
</span>
</dt>
<dd>
<p>Scheme of the request, such as "https".
Note: The <code class="literal">:</code> is not part of the scheme.</p>
<p>type: keyword</p>
<p>example: https</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">url.top_level_domain</code></strong></span>
</span>
</dt>
<dd>
<p>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 (<a href="http://publicsuffix.org" class="ulink" target="_top">http://publicsuffix.org</a>). Trying to approximate this by simply taking the last label will not work well for effective TLDs such as "co.uk".</p>
<p>type: keyword</p>
<p>example: co.uk</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">url.username</code></strong></span>
</span>
</dt>
<dd>
<p>Username of the request.</p>
<p>type: keyword</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_user"></a>user</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.7/docs/fields.asciidoc">edit</a></div>
<p>The user fields describe information about the user that is relevant to the event.
Fields can have one entry or multiple entries. If a user has more than one id, provide an array that includes all of them.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">user.domain</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the directory the user is a member of.
For example, an LDAP or Active Directory domain name.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">user.email</code></strong></span>
</span>
</dt>
<dd>
<p>User email address.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">user.full_name</code></strong></span>
</span>
</dt>
<dd>
<p>User&#8217;s full name, if available.</p>
<p>type: keyword</p>
<p>example: Albert Einstein</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">user.full_name.text</code></strong></span>
</span>
</dt>
<dd>
<p>type: text</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">user.group.domain</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the directory the group is a member of.
For example, an LDAP or Active Directory domain name.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">user.group.id</code></strong></span>
</span>
</dt>
<dd>
<p>Unique identifier for the group on the system/platform.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">user.group.name</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the group.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">user.hash</code></strong></span>
</span>
</dt>
<dd>
<p>Unique user hash to correlate information for a user in anonymized form.
Useful if <code class="literal">user.id</code> or <code class="literal">user.name</code> contain confidential information and cannot be used.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">user.id</code></strong></span>
</span>
</dt>
<dd>
<p>Unique identifiers of the user.</p>
<p>type: keyword</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">user.name</code></strong></span>
</span>
</dt>
<dd>
<p>Short name or login of the user.</p>
<p>type: keyword</p>
<p>example: albert</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">user.name.text</code></strong></span>
</span>
</dt>
<dd>
<p>type: text</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_user_agent_2"></a>user_agent</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.7/docs/fields.asciidoc">edit</a></div>
<p>The user_agent fields normally come from a browser request.
They often show up in web service logs coming from the parsed user agent string.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">user_agent.device.name</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the device.</p>
<p>type: keyword</p>
<p>example: iPhone</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">user_agent.name</code></strong></span>
</span>
</dt>
<dd>
<p>Name of the user agent.</p>
<p>type: keyword</p>
<p>example: Safari</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">user_agent.original</code></strong></span>
</span>
</dt>
<dd>
<p>Unparsed user_agent string.</p>
<p>type: keyword</p>
<p>example: Mozilla/5.0 (iPhone; CPU iPhone OS 12_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/12.0 Mobile/15E148 Safari/604.1</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">user_agent.original.text</code></strong></span>
</span>
</dt>
<dd>
<p>type: text</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">user_agent.os.family</code></strong></span>
</span>
</dt>
<dd>
<p>OS family (such as redhat, debian, freebsd, windows).</p>
<p>type: keyword</p>
<p>example: debian</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">user_agent.os.full</code></strong></span>
</span>
</dt>
<dd>
<p>Operating system name, including the version or code name.</p>
<p>type: keyword</p>
<p>example: Mac OS Mojave</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">user_agent.os.full.text</code></strong></span>
</span>
</dt>
<dd>
<p>type: text</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">user_agent.os.kernel</code></strong></span>
</span>
</dt>
<dd>
<p>Operating system kernel version as a raw string.</p>
<p>type: keyword</p>
<p>example: 4.4.0-112-generic</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">user_agent.os.name</code></strong></span>
</span>
</dt>
<dd>
<p>Operating system name, without the version.</p>
<p>type: keyword</p>
<p>example: Mac OS X</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">user_agent.os.name.text</code></strong></span>
</span>
</dt>
<dd>
<p>type: text</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">user_agent.os.platform</code></strong></span>
</span>
</dt>
<dd>
<p>Operating system platform (such centos, ubuntu, windows).</p>
<p>type: keyword</p>
<p>example: darwin</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">user_agent.os.version</code></strong></span>
</span>
</dt>
<dd>
<p>Operating system version as a raw string.</p>
<p>type: keyword</p>
<p>example: 10.14.1</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">user_agent.version</code></strong></span>
</span>
</dt>
<dd>
<p>Version of the user agent.</p>
<p>type: keyword</p>
<p>example: 12.0</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_vlan"></a>vlan</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.7/docs/fields.asciidoc">edit</a></div>
<p>The VLAN fields are used to identify 802.1q tag(s) of a packet, as well as ingress and egress VLAN associations of an observer in relation to a specific packet or connection.
Network.vlan fields are used to record a single VLAN tag, or the outer tag in the case of q-in-q encapsulations, for a packet or connection as observed, typically provided by a network sensor (e.g. Zeek, Wireshark) passively reporting on traffic.
Network.inner VLAN fields are used to report inner q-in-q 802.1q tags (multiple 802.1q encapsulations) as observed, typically provided by a network sensor  (e.g. Zeek, Wireshark) passively reporting on traffic. Network.inner VLAN fields should only be used in addition to network.vlan fields to indicate q-in-q tagging.
Observer.ingress and observer.egress VLAN values are used to record observer specific information when observer events contain discrete ingress and egress VLAN information, typically provided by firewalls, routers, or load balancers.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">vlan.id</code></strong></span>
</span>
</dt>
<dd>
<p>VLAN ID as reported by the observer.</p>
<p>type: keyword</p>
<p>example: 10</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">vlan.name</code></strong></span>
</span>
</dt>
<dd>
<p>Optional VLAN name as reported by the observer.</p>
<p>type: keyword</p>
<p>example: outside</p>
</dd>
</dl>
</div>
<div class="position-relative"><h3><a id="_vulnerability"></a>vulnerability</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.7/docs/fields.asciidoc">edit</a></div>
<p>The vulnerability fields describe information about a vulnerability that is relevant to an event.</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">vulnerability.category</code></strong></span>
</span>
</dt>
<dd>
<p>The type of system or architecture that the vulnerability affects. These may be platform-specific (for example, Debian or SUSE) or general (for example, Database or Firewall). For example (<a href="https://qualysguard.qualys.com/qwebhelp/fo_portal/knowledgebase/vulnerability_categories.htm" class="ulink" target="_top">Qualys vulnerability categories</a>)
This field must be an array.</p>
<p>type: keyword</p>
<p>example: ["Firewall"]</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">vulnerability.classification</code></strong></span>
</span>
</dt>
<dd>
<p>The classification of the vulnerability scoring system. For example (<a href="https://www.first.org/cvss/" class="ulink" target="_top">https://www.first.org/cvss/</a>)</p>
<p>type: keyword</p>
<p>example: CVSS</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">vulnerability.description</code></strong></span>
</span>
</dt>
<dd>
<p>The description of the vulnerability that provides additional context of the vulnerability. For example (<a href="https://cve.mitre.org/about/faqs.html#cve_entry_descriptions_created" class="ulink" target="_top">Common Vulnerabilities and Exposure CVE description</a>)</p>
<p>type: keyword</p>
<p>example: In macOS before 2.12.6, there is a vulnerability in the RPC&#8230;&#8203;</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">vulnerability.description.text</code></strong></span>
</span>
</dt>
<dd>
<p>type: text</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">vulnerability.enumeration</code></strong></span>
</span>
</dt>
<dd>
<p>The type of identifier used for this vulnerability. For example (<a href="https://cve.mitre.org/about/" class="ulink" target="_top">https://cve.mitre.org/about/</a>)</p>
<p>type: keyword</p>
<p>example: CVE</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">vulnerability.id</code></strong></span>
</span>
</dt>
<dd>
<p>The identification (ID) is the number portion of a vulnerability entry. It includes a unique identification number for the vulnerability. For example (<a href="https://cve.mitre.org/about/faqs.html#what_is_cve_id)" class="ulink" target="_top">Common Vulnerabilities and Exposure CVE ID</a></p>
<p>type: keyword</p>
<p>example: CVE-2019-00001</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">vulnerability.reference</code></strong></span>
</span>
</dt>
<dd>
<p>A resource that provides additional information, context, and mitigations for the identified vulnerability.</p>
<p>type: keyword</p>
<p>example: <a href="https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2019-6111" class="ulink" target="_top">https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2019-6111</a></p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">vulnerability.report_id</code></strong></span>
</span>
</dt>
<dd>
<p>The report or scan identification number.</p>
<p>type: keyword</p>
<p>example: 20191018.0001</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">vulnerability.scanner.vendor</code></strong></span>
</span>
</dt>
<dd>
<p>The name of the vulnerability scanner vendor.</p>
<p>type: keyword</p>
<p>example: Tenable</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">vulnerability.score.base</code></strong></span>
</span>
</dt>
<dd>
<p>Scores can range from 0.0 to 10.0, with 10.0 being the most severe.
Base scores cover an assessment for exploitability metrics (attack vector, complexity, privileges, and user interaction), impact metrics (confidentiality, integrity, and availability), and scope. For example (<a href="https://www.first.org/cvss/specification-document" class="ulink" target="_top">https://www.first.org/cvss/specification-document</a>)</p>
<p>type: float</p>
<p>example: 5.5</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">vulnerability.score.environmental</code></strong></span>
</span>
</dt>
<dd>
<p>Scores can range from 0.0 to 10.0, with 10.0 being the most severe.
Environmental scores cover an assessment for any modified Base metrics, confidentiality, integrity, and availability requirements. For example (<a href="https://www.first.org/cvss/specification-document" class="ulink" target="_top">https://www.first.org/cvss/specification-document</a>)</p>
<p>type: float</p>
<p>example: 5.5</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">vulnerability.score.temporal</code></strong></span>
</span>
</dt>
<dd>
<p>Scores can range from 0.0 to 10.0, with 10.0 being the most severe.
Temporal scores cover an assessment for code maturity, remediation level, and confidence. For example (<a href="https://www.first.org/cvss/specification-document" class="ulink" target="_top">https://www.first.org/cvss/specification-document</a>)</p>
<p>type: float</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">vulnerability.score.version</code></strong></span>
</span>
</dt>
<dd>
<p>The National Vulnerability Database (NVD) provides qualitative severity rankings of "Low", "Medium", and "High" for CVSS v2.0 base score ranges in addition to the severity ratings for CVSS v3.0 as they are defined in the CVSS v3.0 specification.
CVSS is owned and managed by FIRST.Org, Inc. (FIRST), a US-based non-profit organization, whose mission is to help computer security incident response teams across the world. For example (<a href="https://nvd.nist.gov/vuln-metrics/cvss" class="ulink" target="_top">https://nvd.nist.gov/vuln-metrics/cvss</a>)</p>
<p>type: keyword</p>
<p>example: 2.0</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">vulnerability.severity</code></strong></span>
</span>
</dt>
<dd>
<p>The severity of the vulnerability can help with metrics and internal prioritization regarding remediation. For example (<a href="https://nvd.nist.gov/vuln-metrics/cvss" class="ulink" target="_top">https://nvd.nist.gov/vuln-metrics/cvss</a>)</p>
<p>type: keyword</p>
<p>example: Critical</p>
</dd>
</dl>
</div>
</div>
</div>
</div><div class="navfooter">
<span class="prev">
<a href="exported-fields-docker-processor.html">« Docker fields</a>
</span>
<span class="next">
<a href="exported-fields-host-processor.html">Host fields »</a>
</span>
</div>

                  <!-- end body -->
                </div>

                <div class="col-12 order-3 col-lg-2 order-lg-3 h-almost-full-lg sticky-top-lg" id="right_col">
                  <div id="sticky_content">
                    <!-- The OTP is appended here -->
                    <div class="row">
                      <div class="col-0 col-md-4 col-lg-0" id="bottom_left_col"></div>
                      <div class="col-12 col-md-8 col-lg-12">
                        <div id="rtpcontainer">
                          <div class="mktg-promo" id="most-popular">
                            <p class="aside-heading">Most Popular</p>
                            <div class="pb-2">
                              <p class="media-type">Video</p>
                              <a href="https://www.elastic.co/webinars/getting-started-elasticsearch?page=docs&placement=top-video">
                                <p class="mb-0">Get Started with Elasticsearch</p>
                              </a>
                            </div>
                            <div class="pb-2">
                              <p class="media-type">Video</p>
                              <a href="https://www.elastic.co/webinars/getting-started-kibana?page=docs&placement=top-video">
                                <p class="mb-0">Intro to Kibana</p>
                              </a>
                            </div>
                            <div class="pb-2">
                              <p class="media-type">Video</p>
                              <a href="https://www.elastic.co/webinars/introduction-elk-stack?page=docs&placement=top-video">
                                <p class="mb-0">ELK for Logs & Metrics</p>
                              </a>
                            </div>
                          </div>
                        </div>

                        <!-- Feedback widget -->
                        <div id="feedbackWidgetContainer"></div>
                      </div>
                    </div>
                  </div>
                </div>
              </div>
            </div>
          </section>

        </div>


        <div id='elastic-footer'></div>
        <script src='https://www.elastic.co/elastic-footer.js'></script>
        <!-- Footer Section end-->

      </section>
    </div>

    <!-- Feedback modal -->
    <div id="feedbackModalContainer"></div>

    <script src="/guide/static/jquery.js"></script>
    <script type="text/javascript" src="/guide/static/docs-v1.js"></script>
    <script type="text/javascript">
  window.initial_state = {}</script>
  </body>
</html>