Skip to content

Commit

Permalink
[editorial] Data model appendix: table-entry markdown and typo fixes (#…
Browse files Browse the repository at this point in the history
…3571)

- Contributes to
open-telemetry/opentelemetry.io#1170, because
of OTel spec pages
- Replaces `attribute["client.address"]` by
`Attributes["client.address"]`, since `attribute` appears to be a
**typo**
- Fixes `<td>` spread across multiple lines with intervening blank
lines, since that generates **invalid HTML** in some cases.
  - In most cases I replaced line breaks with `<br>`.
- Replaces code tick markdown syntax in two places since those entries
are in "HTML-only" format.
  For example: replaces \`Debug\` by `<code>Debug</code>`

/cc @svrnm @cartermp
  • Loading branch information
chalin authored Jun 28, 2023
1 parent a8183ba commit c07f4a2
Showing 1 changed file with 13 additions and 30 deletions.
43 changes: 13 additions & 30 deletions specification/logs/data-model-appendix.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,13 @@ this data model.
<tr>
<td>SEVERITY</td>
<td>enum</td>
<td>Defines the importance of the event. Example: `Debug`</td>
<td>Defines the importance of the event. Example: <code>Debug</code></td>
<td>Severity</td>
</tr>
<tr>
<td>FACILITY</td>
<td>enum</td>
<td>Describes where the event originated. A predefined list of Unix processes. Part of event source identity. Example: `mail system`</td>
<td>Describes where the event originated. A predefined list of Unix processes. Part of event source identity. Example: <code>mail system</code></td>
<td>Attributes["syslog.facility"]</td>
</tr>
<tr>
Expand Down Expand Up @@ -87,15 +87,11 @@ this data model.
<tr>
<td>STRUCTURED-DATA</td>
<td>array of maps of string to string</td>
<td>A variety of use cases depending on the SDID:
Can describe event source identity
Can include data that describes particular occurrence of the event.
<td>A variety of use cases depending on the SDID:<br>
Can describe event source identity.<br>
Can include data that describes particular occurrence of the event.<br>
Can be meta-information, e.g. quality of timestamp value.</td>
<td>SDID origin.swVersion map to Resource["service.version"]

SDID origin.ip map to attribute["client.address"]

Rest of SDIDs -> Attributes["syslog.*"]</td>
<td>SDID origin.swVersion map to Resource["service.version"]. SDID origin.ip map to Attributes["client.address"]. Rest of SDIDs -> Attributes["syslog.*"]</td>
</tr>
<tr>
<td>MSG</td>
Expand Down Expand Up @@ -705,21 +701,14 @@ All other fields | |
<tr>
<td>host.domain</td>
<td>string</td>
<td>Name of the domain of which the host is a member.

For example, on Windows this could be the host’s Active Directory domain or NetBIOS domain name. For Linux this could be the domain of the host’s LDAP provider.</td>

<td>**Resource</td>
<td>Name of the domain of which the host is a member.<br>For example, on Windows this could be the host’s Active Directory domain or NetBIOS domain name. For Linux this could be the domain of the host’s LDAP provider.</td>
<td>**Resource</td>
</tr>
<tr>
<td>host.name</td>
<td>string</td>
<td>Hostname of the host.

It normally contains what the hostname command returns on the host machine.</td>

<td>Resource["host.name"]</td>

<td>Hostname of the host.<br>It normally contains what the hostname command returns on the host machine.</td>
<td>Resource["host.name"]</td>
</tr>
<tr>
<td>host.id</td>
Expand All @@ -742,12 +731,8 @@ It normally contains what the hostname command returns on the host machine.</td>
<tr>
<td>host.name</td>
<td>string</td>
<td>Name of the host.

It may contain what hostname returns on Unix systems, the fully qualified, or a name specified by the user. </td>

<td>Resource["host.name"]</td>

<td>Name of the host.<br>It may contain what hostname returns on Unix systems, the fully qualified, or a name specified by the user. </td>
<td>Resource["host.name"]</td>
</tr>
<tr>
<td>host.type</td>
Expand All @@ -762,9 +747,7 @@ It may contain what hostname returns on Unix systems, the fully qualified, or a
<td>?</td>
</tr>
<tr>
<td>service.ephemeral_id

</td>
<td>service.ephemeral_id</td>
<td>string</td>
<td>Ephemeral identifier of this service</td>
<td>**Resource</td>
Expand Down

0 comments on commit c07f4a2

Please sign in to comment.