Rename record to body #88

lastchiliarch · 2021-04-05T15:49:23Z

Rename record to body, see #83 .

djaglowski · 2021-04-05T16:26:18Z

I think we need to extend this to other usages of the term "Record". Particularly, anywhere users will see the term "record":

Documentation
Fields
- RecordField / NewRecordField
- $record syntax
Variable names, particularly in tests (inputRecord \ exptectedRecord)

lastchiliarch · 2021-04-05T17:54:10Z

I think we need to extend this to other usages of the term "Record". Particularly, anywhere users will see the term "record":

Documentation

Fields

RecordField / NewRecordField

$record syntax

Variable names, particularly in tests (inputRecord \ exptectedRecord)

Thanks very much. Please remend me if anything is forgeted.

djaglowski

This looks great. A few very minor suggestions.

It looks like there are a few more files to update.

> grep -Iris record .
./docs/types/severity.md:  "record": {
./docs/types/severity.md:  "record": {}
./docs/types/severity.md:  "record": {
./docs/types/severity.md:  "record": {}
./docs/types/severity.md:  "record": {
./docs/types/severity.md:  "record": {}
./docs/types/severity.md:  "record": {
./docs/types/severity.md:  "record": {}
./docs/types/severity.md:  "record": {
./docs/types/severity.md:  "record": {}
./docs/types/severity.md:  "record": {
./docs/types/severity.md:  "record": {}
./docs/types/severity.md:  "record": {
./docs/types/severity.md:  "record": {}
./docs/types/severity.md:  "record": {
./docs/types/severity.md:  "record": {}
./docs/types/severity.md:  "record": {
./docs/types/severity.md:  "record": {}
./docs/types/severity.md:  "record": {
./docs/types/severity.md:  "record": {}
./docs/types/severity.md:  "record": {
./docs/types/severity.md:  "record": {}
./docs/types/severity.md:  "record": {
./docs/types/severity.md:  "record": {}
./docs/types/severity.md:  "record": {
./docs/types/severity.md:  "record": {}
./docs/types/severity.md:  "record": {
./docs/types/severity.md:  "record": {}
./docs/types/severity.md:  "record": {
./docs/types/severity.md:  "record": {}
./docs/types/severity.md:  "record": {
./docs/types/severity.md:  "record": {}
./docs/operators/windows_eventlog_input.md:  "record": {
./docs/operators/k8s_event_input.md:  "record": {
./docs/operators/restructure.md:`value_expr` is an [expression](/docs/types/expression.md) with access to the `record` object
./docs/operators/restructure.md:<tr><td> Input record </td> <td> Output record </td></tr>
./docs/operators/restructure.md:The `remove` op removes a field from a record.
./docs/operators/restructure.md:<tr><td> Input record </td> <td> Output record </td></tr>
./docs/operators/restructure.md:<tr><td> Input record </td> <td> Output record </td></tr>
./docs/operators/restructure.md:<tr><td> Input record </td> <td> Output record </td></tr>
./docs/operators/restructure.md:<tr><td> Input record </td> <td> Output record </td></tr>

I omitted these lines from the above output, because I believe they use record in a different context and should be left as is:

./docs/operators/windows_eventlog_input.md:             "record_id": 1,
./operator/builtin/input/windows/subscription.go:               return EvtSubscribeStartAtOldestRecord
./operator/builtin/input/windows/xml.go:        RecordID    uint64      `xml:"System>EventRecordID"`
./operator/builtin/input/windows/xml.go:                "record_id":   e.RecordID,
./operator/builtin/input/windows/api.go:        // EvtSubscribeStartAtOldestRecord is a flag that will subscribe to all existing and future events.
./operator/builtin/input/windows/api.go:        EvtSubscribeStartAtOldestRecord uint32 = 2
./operator/builtin/input/windows/xml_test.go:           RecordID: 1,
./operator/builtin/input/windows/xml_test.go:           "record_id":   uint64(1),

djaglowski · 2021-04-05T20:52:15Z

docs/operators/windows_eventlog_input.md

 | `start_at`      | `end`                    | On first startup, where to start reading logs from the API. Options are `beginning` or `end`                                   |
-| `poll_interval` | 1s                       | The interval at which the channel is checked for new log entries. This check begins again after all new records have been read |
-| `write_to`      | $                        | The record [field](/docs/types/field.md) written to when creating a new log entry                                              |
+| `poll_interval` | 1s                       | The interval at which the channel is checked for new log entries. This check begins again after all new body have been read |


Suggested change

| `poll_interval` | 1s | The interval at which the channel is checked for new log entries. This check begins again after all new body have been read |

| `poll_interval` | 1s | The interval at which the channel is checked for new log entries. This check begins again after all new bodies have been read |

This looks great. A few very minor suggestions.

It looks like there are a few more files to update.

> grep -Iris record . ./docs/types/severity.md: "record": { ./docs/types/severity.md: "record": {} ./docs/types/severity.md: "record": { ./docs/types/severity.md: "record": {} ./docs/types/severity.md: "record": { ./docs/types/severity.md: "record": {} ./docs/types/severity.md: "record": { ./docs/types/severity.md: "record": {} ./docs/types/severity.md: "record": { ./docs/types/severity.md: "record": {} ./docs/types/severity.md: "record": { ./docs/types/severity.md: "record": {} ./docs/types/severity.md: "record": { ./docs/types/severity.md: "record": {} ./docs/types/severity.md: "record": { ./docs/types/severity.md: "record": {} ./docs/types/severity.md: "record": { ./docs/types/severity.md: "record": {} ./docs/types/severity.md: "record": { ./docs/types/severity.md: "record": {} ./docs/types/severity.md: "record": { ./docs/types/severity.md: "record": {} ./docs/types/severity.md: "record": { ./docs/types/severity.md: "record": {} ./docs/types/severity.md: "record": { ./docs/types/severity.md: "record": {} ./docs/types/severity.md: "record": { ./docs/types/severity.md: "record": {} ./docs/types/severity.md: "record": { ./docs/types/severity.md: "record": {} ./docs/types/severity.md: "record": { ./docs/types/severity.md: "record": {} ./docs/operators/windows_eventlog_input.md: "record": { ./docs/operators/k8s_event_input.md: "record": { ./docs/operators/restructure.md:`value_expr` is an [expression](/docs/types/expression.md) with access to the `record` object ./docs/operators/restructure.md:<tr><td> Input record </td> <td> Output record </td></tr> ./docs/operators/restructure.md:The `remove` op removes a field from a record. ./docs/operators/restructure.md:<tr><td> Input record </td> <td> Output record </td></tr> ./docs/operators/restructure.md:<tr><td> Input record </td> <td> Output record </td></tr> ./docs/operators/restructure.md:<tr><td> Input record </td> <td> Output record </td></tr> ./docs/operators/restructure.md:<tr><td> Input record </td> <td> Output record </td></tr>

I omitted these lines from the above output, because I believe they use record in a different context and should be left as is:

./docs/operators/windows_eventlog_input.md: "record_id": 1, ./operator/builtin/input/windows/subscription.go: return EvtSubscribeStartAtOldestRecord ./operator/builtin/input/windows/xml.go: RecordID uint64 `xml:"System>EventRecordID"` ./operator/builtin/input/windows/xml.go: "record_id": e.RecordID, ./operator/builtin/input/windows/api.go: // EvtSubscribeStartAtOldestRecord is a flag that will subscribe to all existing and future events. ./operator/builtin/input/windows/api.go: EvtSubscribeStartAtOldestRecord uint32 = 2 ./operator/builtin/input/windows/xml_test.go: RecordID: 1, ./operator/builtin/input/windows/xml_test.go: "record_id": uint64(1),

thanks a lot!

djaglowski · 2021-04-05T20:52:52Z

docs/types/field.md

@@ -1,18 +1,18 @@
-## Fields
+##  


Suggested change

##

## Fields

djaglowski

LGTM. Thank you @lastchiliarch for the contribution!

Follows [#88 (opentelemetry-log-collection)](open-telemetry/opentelemetry-log-collection#88) and [#3017 (opentelemetry-collector-contrib)](open-telemetry/opentelemetry-collector-contrib#3017)

Rename record to body (open-telemetry#83)

908f825

lastchiliarch added 3 commits April 6, 2021 01:26

Rename record to body (open-telemetry#83)

082fb7d

Rename record to body (open-telemetry#83)

ce8bb33

Rename record to body (open-telemetry#83)

8455bbc

djaglowski reviewed Apr 5, 2021

View reviewed changes

Rename record to body (open-telemetry#83)

88d6ec3

djaglowski approved these changes Apr 6, 2021

View reviewed changes

djaglowski merged commit 51eca70 into open-telemetry:main Apr 6, 2021

lastchiliarch deleted the issue83 branch April 7, 2021 02:37

This was referenced Apr 8, 2021

Rename log 'record' to 'body' open-telemetry/opentelemetry-helm-charts#44

Merged

Rename "record" to "body" #83

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rename record to body #88

Rename record to body #88

lastchiliarch commented Apr 5, 2021

djaglowski commented Apr 5, 2021

lastchiliarch commented Apr 5, 2021

djaglowski left a comment

djaglowski Apr 5, 2021

lastchiliarch Apr 6, 2021

djaglowski Apr 5, 2021

djaglowski left a comment

	\| `poll_interval` \| 1s \| The interval at which the channel is checked for new log entries. This check begins again after all new body have been read \|
	\| `poll_interval` \| 1s \| The interval at which the channel is checked for new log entries. This check begins again after all new bodies have been read \|

Rename record to body #88

Rename record to body #88

Conversation

lastchiliarch commented Apr 5, 2021

djaglowski commented Apr 5, 2021

lastchiliarch commented Apr 5, 2021

djaglowski left a comment

Choose a reason for hiding this comment

djaglowski Apr 5, 2021

Choose a reason for hiding this comment

lastchiliarch Apr 6, 2021

Choose a reason for hiding this comment

djaglowski Apr 5, 2021

Choose a reason for hiding this comment

djaglowski left a comment

Choose a reason for hiding this comment