Skip to content

Commit d3619c5

Browse files
update splunk hec data model (#1861)
Co-authored-by: Carlos Alberto Cortez <[email protected]>
1 parent 5d0abb0 commit d3619c5

File tree

1 file changed

+42
-38
lines changed

1 file changed

+42
-38
lines changed

specification/logs/data-model.md

+42-38
Original file line numberDiff line numberDiff line change
@@ -2,41 +2,45 @@
22

33
**Status**: [Experimental](../document-status.md)
44

5-
* [Design Notes](#design-notes)
6-
* [Requirements](#requirements)
7-
* [Field Kinds](#field-kinds)
8-
* [Log and Event Record Definition](#log-and-event-record-definition)
9-
* [Field: `Timestamp`](#field-timestamp)
10-
* [Trace Context Fields](#trace-context-fields)
11-
* [Field: `TraceId`](#field-traceid)
12-
* [Field: `SpanId`](#field-spanid)
13-
* [Field: `TraceFlags`](#field-traceflags)
14-
* [Severity Fields](#severity-fields)
15-
* [Field: `SeverityText`](#field-severitytext)
16-
* [Field: `SeverityNumber`](#field-severitynumber)
17-
* [Mapping of `SeverityNumber`](#mapping-of-severitynumber)
18-
* [Reverse Mapping](#reverse-mapping)
19-
* [Error Semantics](#error-semantics)
20-
* [Displaying Severity](#displaying-severity)
21-
* [Comparing Severity](#comparing-severity)
22-
* [Field: `Name`](#field-name)
23-
* [Field: `Body`](#field-body)
24-
* [Field: `Resource`](#field-resource)
25-
* [Field: `Attributes`](#field-attributes)
26-
* [Example Log Records](#example-log-records)
27-
* [Appendix A. Example Mappings](#appendix-a-example-mappings)
28-
* [RFC5424 Syslog](#rfc5424-syslog)
29-
* [Windows Event Log](#windows-event-log)
30-
* [SignalFx Events](#signalfx-events)
31-
* [Splunk HEC](#splunk-hec)
32-
* [Log4j](#log4j)
33-
* [Zap](#zap)
34-
* [Apache HTTP Server access log](#apache-http-server-access-log)
35-
* [CloudTrail Log Event](#cloudtrail-log-event)
36-
* [Google Cloud Logging](#google-cloud-logging)
37-
* [Elastic Common Schema](#elastic-common-schema)
38-
* [Appendix B: `SeverityNumber` example mappings](#appendix-b-severitynumber-example-mappings)
39-
* [References](#references)
5+
- [Log Data Model](#log-data-model)
6+
- [Design Notes](#design-notes)
7+
- [Requirements](#requirements)
8+
- [Definitions Used in this Document](#definitions-used-in-this-document)
9+
- [Type `any`](#type-any)
10+
- [Type `map<string, any>`](#type-mapstring-any)
11+
- [Field Kinds](#field-kinds)
12+
- [Log and Event Record Definition](#log-and-event-record-definition)
13+
- [Field: `Timestamp`](#field-timestamp)
14+
- [Trace Context Fields](#trace-context-fields)
15+
- [Field: `TraceId`](#field-traceid)
16+
- [Field: `SpanId`](#field-spanid)
17+
- [Field: `TraceFlags`](#field-traceflags)
18+
- [Severity Fields](#severity-fields)
19+
- [Field: `SeverityText`](#field-severitytext)
20+
- [Field: `SeverityNumber`](#field-severitynumber)
21+
- [Mapping of `SeverityNumber`](#mapping-of-severitynumber)
22+
- [Reverse Mapping](#reverse-mapping)
23+
- [Error Semantics](#error-semantics)
24+
- [Displaying Severity](#displaying-severity)
25+
- [Comparing Severity](#comparing-severity)
26+
- [Field: `Name`](#field-name)
27+
- [Field: `Body`](#field-body)
28+
- [Field: `Resource`](#field-resource)
29+
- [Field: `Attributes`](#field-attributes)
30+
- [Example Log Records](#example-log-records)
31+
- [Appendix A. Example Mappings](#appendix-a-example-mappings)
32+
- [RFC5424 Syslog](#rfc5424-syslog)
33+
- [Windows Event Log](#windows-event-log)
34+
- [SignalFx Events](#signalfx-events)
35+
- [Splunk HEC](#splunk-hec)
36+
- [Log4j](#log4j)
37+
- [Zap](#zap)
38+
- [Apache HTTP Server access log](#apache-http-server-access-log)
39+
- [CloudTrail Log Event](#cloudtrail-log-event)
40+
- [Google Cloud Logging](#google-cloud-logging)
41+
- [Elastic Common Schema](#elastic-common-schema)
42+
- [Appendix B: `SeverityNumber` example mappings](#appendix-b-severitynumber-example-mappings)
43+
- [References](#references)
4044

4145
This is a data model and semantic conventions that allow to represent logs from
4246
various sources: application log files, machine generated events, system logs,
@@ -687,13 +691,13 @@ Rest of SDIDs -> Attributes["syslog.*"]</td>
687691
<td>source</td>
688692
<td>string</td>
689693
<td>The source value to assign to the event data. For example, if you are sending data from an app you are developing, you could set this key to the name of the app.</td>
690-
<td>Resource["service.name"]</td>
694+
<td>Resource["com.splunk.source"]</td>
691695
</tr>
692696
<tr>
693697
<td>sourcetype</td>
694698
<td>string</td>
695699
<td>The sourcetype value to assign to the event data.</td>
696-
<td>Attributes["source.type"]</td>
700+
<td>Resource["com.splunk.sourcetype"]</td>
697701
</tr>
698702
<tr>
699703
<td>event</td>
@@ -711,7 +715,7 @@ Rest of SDIDs -> Attributes["syslog.*"]</td>
711715
<td>index</td>
712716
<td>string</td>
713717
<td>The name of the index by which the event data is to be indexed. The index you specify here must be within the list of allowed indexes if the token has the indexes parameter set.</td>
714-
<td>TBD, most like will go to attributes</td>
718+
<td>Attributes["com.splunk.index"]</td>
715719
</tr>
716720
</table>
717721

0 commit comments

Comments
 (0)