forked from open-telemetry/opentelemetry-collector-contrib
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[exporter/awss3] add marsheler config to pick only body content of lo…
…gs (open-telemetry#30318) **Description:** <Describe what has changed.> This pull request introduces a new marshaller for the awss3 exporter. It disregards resources, labels, and selectively extracts only the body content of the logs, facilitating simplified AWS Athena connection and querying. While straightforward, this enhancement accommodates various use cases, enabling the extraction of specific logs for statistical analysis and long-term archival reporting. Example when write only body to S3: ``` EXTERNAL_REQUEST 2023-07-18T10:05:01.976Z GET 200 localhost /organization/v0/properties 0:0:0:0:0:0:0:1 4264 348 wUN0NeTMByHVmIOjo79ImwylAjjkRtkr EXTERNAL_REQUEST 2023-07-18T10:05:01.976Z GET 200 localhost /organization/v0/properties 0:0:0:0:0:0:0:1 4264 348 wUN0NeTMByHVmIOjo79ImwylAjjkRtkr EXTERNAL_REQUEST 2023-07-18T10:05:01.976Z GET 200 localhost /organization/v0/properties 0:0:0:0:0:0:0:1 4264 348 wUN0NeTMByHVmIOjo79ImwylAjjkRtkr EXTERNAL_REQUEST 2023-07-18T10:05:01.976Z GET 200 localhost /organization/v0/properties 0:0:0:0:0:0:0:1 4264 348 wUN0NeTMByHVmIOjo79ImwylAjjkRtkr ``` **Testing:** Work as expected when used Athena to Query: <img width="962" alt="athena" src="https://github.com/open-telemetry/opentelemetry-collector-contrib/assets/85854989/8f682024-df4e-402b-9de1-ee8268ea1936">
- Loading branch information
1 parent
a41bcb8
commit 7149baa
Showing
7 changed files
with
172 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# Use this changelog template to create an entry for release notes. | ||
|
||
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' | ||
change_type: enhancement | ||
|
||
# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver) | ||
component: awss3exporter | ||
|
||
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). | ||
note: Add a marshaler that stores the body of log records in s3. | ||
# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. | ||
issues: [30318] | ||
|
||
# (Optional) One or more lines of additional information to render under the primary note. | ||
# These lines will be padded with 2 spaces and then inserted directly into the document. | ||
# Use pipe (|) for multiline entries. | ||
subtext: | ||
|
||
# If your change doesn't affect end users or the exported elements of any package, | ||
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label. | ||
# Optional: The change log or logs in which this entry should be included. | ||
# e.g. '[user]' or '[user, api]' | ||
# Include 'user' if the change is relevant to end users. | ||
# Include 'api' if there is a change to a library API. | ||
# Default: '[user]' | ||
change_logs: [user] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
// Copyright The OpenTelemetry Authors | ||
// SPDX-License-Identifier: Apache-2.0 | ||
|
||
package awss3exporter // import "github.com/open-telemetry/opentelemetry-collector-contrib/exporter/awss3exporter" | ||
|
||
import ( | ||
"bytes" | ||
"fmt" | ||
|
||
"go.opentelemetry.io/collector/pdata/plog" | ||
"go.opentelemetry.io/collector/pdata/pmetric" | ||
"go.opentelemetry.io/collector/pdata/ptrace" | ||
) | ||
|
||
type bodyMarshaler struct{} | ||
|
||
func (*bodyMarshaler) format() string { | ||
return "txt" | ||
} | ||
|
||
func newbodyMarshaler() bodyMarshaler { | ||
return bodyMarshaler{} | ||
} | ||
|
||
func (bodyMarshaler) MarshalLogs(ld plog.Logs) ([]byte, error) { | ||
buf := bytes.Buffer{} | ||
rls := ld.ResourceLogs() | ||
for i := 0; i < rls.Len(); i++ { | ||
rl := rls.At(i) | ||
|
||
ills := rl.ScopeLogs() | ||
for j := 0; j < ills.Len(); j++ { | ||
ils := ills.At(j) | ||
logs := ils.LogRecords() | ||
for k := 0; k < logs.Len(); k++ { | ||
lr := logs.At(k) | ||
body := lr.Body() | ||
buf.WriteString(body.AsString()) | ||
buf.WriteString("\n") | ||
} | ||
} | ||
} | ||
return buf.Bytes(), nil | ||
} | ||
|
||
func (s bodyMarshaler) MarshalTraces(_ ptrace.Traces) ([]byte, error) { | ||
return nil, fmt.Errorf("traces can't be marshaled into %s format", s.format()) | ||
} | ||
|
||
func (s bodyMarshaler) MarshalMetrics(_ pmetric.Metrics) ([]byte, error) { | ||
return nil, fmt.Errorf("metrics can't be marshaled into %s format", s.format()) | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
// Copyright The OpenTelemetry Authors | ||
// SPDX-License-Identifier: Apache-2.0 | ||
|
||
package awss3exporter | ||
|
||
import ( | ||
"testing" | ||
"time" | ||
|
||
"github.com/stretchr/testify/assert" | ||
"github.com/stretchr/testify/require" | ||
"go.opentelemetry.io/collector/pdata/pcommon" | ||
"go.opentelemetry.io/collector/pdata/plog" | ||
) | ||
|
||
func TestBodyMarshalerWithBooleanType(t *testing.T) { | ||
logs := plog.NewLogs() | ||
rls := logs.ResourceLogs().AppendEmpty() | ||
sl := rls.ScopeLogs().AppendEmpty() | ||
|
||
const recordNum = 0 | ||
ts := pcommon.Timestamp(int64(recordNum) * time.Millisecond.Nanoseconds()) | ||
logRecord := sl.LogRecords().AppendEmpty() | ||
logRecord.SetTimestamp(ts) | ||
|
||
// Boolean | ||
logRecord.Body().SetBool(true) | ||
|
||
marshaler := &bodyMarshaler{} | ||
require.NotNil(t, marshaler) | ||
body, err := marshaler.MarshalLogs(logs) | ||
assert.NoError(t, err) | ||
assert.Equal(t, body, []byte("true\n")) | ||
} | ||
|
||
func TestBodyMarshalerWithNumberType(t *testing.T) { | ||
logs := plog.NewLogs() | ||
rls := logs.ResourceLogs().AppendEmpty() | ||
sl := rls.ScopeLogs().AppendEmpty() | ||
|
||
const recordNum = 0 | ||
ts := pcommon.Timestamp(int64(recordNum) * time.Millisecond.Nanoseconds()) | ||
logRecord := sl.LogRecords().AppendEmpty() | ||
logRecord.SetTimestamp(ts) | ||
|
||
// Number | ||
logRecord.Body().SetDouble(0.05) | ||
|
||
marshaler := &bodyMarshaler{} | ||
require.NotNil(t, marshaler) | ||
body, err := marshaler.MarshalLogs(logs) | ||
assert.NoError(t, err) | ||
assert.Equal(t, body, []byte("0.05\n")) | ||
} | ||
|
||
func TestBodyMarshalerWithMapType(t *testing.T) { | ||
logs := plog.NewLogs() | ||
rls := logs.ResourceLogs().AppendEmpty() | ||
sl := rls.ScopeLogs().AppendEmpty() | ||
|
||
const recordNum = 0 | ||
ts := pcommon.Timestamp(int64(recordNum) * time.Millisecond.Nanoseconds()) | ||
logRecord := sl.LogRecords().AppendEmpty() | ||
logRecord.SetTimestamp(ts) | ||
|
||
// Map | ||
m := logRecord.Body().SetEmptyMap() | ||
m.PutStr("foo", "foo") | ||
m.PutStr("bar", "bar") | ||
m.PutBool("foobar", false) | ||
m.PutDouble("foobardouble", 0.006) | ||
m.PutInt("foobarint", 1) | ||
|
||
var expect = `{"bar":"bar","foo":"foo","foobar":false,"foobardouble":0.006,"foobarint":1}` | ||
|
||
marshaler := &bodyMarshaler{} | ||
require.NotNil(t, marshaler) | ||
body, err := marshaler.MarshalLogs(logs) | ||
assert.NoError(t, err) | ||
assert.Equal(t, body, []byte(expect+"\n")) | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters