Skip to content

Commit d53c5f6

Browse files
make nlb, clb and alb acronyms uppercase
1 parent cfb90b5 commit d53c5f6

File tree

3 files changed

+38
-37
lines changed

3 files changed

+38
-37
lines changed

extension/encoding/awslogsencodingextension/internal/unmarshaler/elb-access-log/elb.go

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ const (
2323
EnableControlMessage = "Enable"
2424
)
2525

26-
// ClbAccessLogRecord represents a record of access logs from an AWS Classic Load Balancer.
26+
// CLBAccessLogRecord represents a record of access logs from an AWS Classic Load Balancer.
2727
// Documentation Reference: https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/access-log-collection.html
28-
type ClbAccessLogRecord struct {
28+
type CLBAccessLogRecord struct {
2929
Time string // Timestamp the load balancer received the request from the client, in ISO 8601 format
3030
ELB string // The name of the load balancer
3131
ClientIP string // Client IP
@@ -47,16 +47,16 @@ type ClbAccessLogRecord struct {
4747
SSLProtocol string // The SSL protocol negotiated, available for HTTPS listeners
4848
}
4949

50-
// convertTextToClbAccessLogRecord converts a slice of strings into a ClbAccessLogRecord
51-
func convertTextToClbAccessLogRecord(fields []string) (ClbAccessLogRecord, error) {
50+
// convertTextToCLBAccessLogRecord converts a slice of strings into a CLBAccessLogRecord
51+
func convertTextToCLBAccessLogRecord(fields []string) (CLBAccessLogRecord, error) {
5252
var err error
5353
fieldsCount := len(fields)
5454
if fieldsCount < 15 {
55-
return ClbAccessLogRecord{}, fmt.Errorf("clb access logs do not have enough fields. Expected 15, got %d", fieldsCount)
55+
return CLBAccessLogRecord{}, fmt.Errorf("clb access logs do not have enough fields. Expected 15, got %d", fieldsCount)
5656
}
5757

5858
// Map fields to the struct
59-
record := ClbAccessLogRecord{
59+
record := CLBAccessLogRecord{
6060
Time: fields[0], // Timestamp
6161
ELB: fields[1], // Load balancer name
6262
BackendIPPort: fields[3], // Backend IP:Port
@@ -113,7 +113,7 @@ func convertTextToClbAccessLogRecord(fields []string) (ClbAccessLogRecord, error
113113

114114
// Network Load Balancer Access Logs record
115115
// Doc: https://docs.aws.amazon.com/elasticloadbalancing/latest//network/load-balancer-access-logs.html#access-log-entry-format
116-
type NlbAccessLogRecord struct {
116+
type NLBAccessLogRecord struct {
117117
Type string // Type of request (tls)
118118
Version string // Version of the log entry
119119
Time string // Timestamp the load balancer generated a response to the client in ISO 8601 format
@@ -139,18 +139,18 @@ type NlbAccessLogRecord struct {
139139
TLSConnectionCreationTime string // Time recorded at the start of the TLS connection, in ISO 8601 format
140140
}
141141

142-
// convertTextToNlbAccessLogRecord converts a slice of strings into a NlbAccessLogRecord
143-
func convertTextToNlbAccessLogRecord(fields []string) (NlbAccessLogRecord, error) {
142+
// convertTextToNLBAccessLogRecord converts a slice of strings into a NLBAccessLogRecord
143+
func convertTextToNLBAccessLogRecord(fields []string) (NLBAccessLogRecord, error) {
144144
var err error
145145
// Check if the fields contain enough data
146146
fieldsCount := len(fields)
147147
if fieldsCount < 22 {
148-
return NlbAccessLogRecord{}, fmt.Errorf(
148+
return NLBAccessLogRecord{}, fmt.Errorf(
149149
"nlb access logs do not have enough fields. Expected 22, got %d", fieldsCount)
150150
}
151151

152152
// Map fields to the struct
153-
record := NlbAccessLogRecord{
153+
record := NLBAccessLogRecord{
154154
Type: fields[0], // Type of request
155155
Version: fields[1], // Log version
156156
Time: fields[2], // Timestamp
@@ -199,7 +199,7 @@ func convertTextToNlbAccessLogRecord(fields []string) (NlbAccessLogRecord, error
199199

200200
// Application Load Balancer Access Logs record
201201
// Doc: https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-access-logs.html
202-
type AlbAccessLogRecord struct {
202+
type ALBAccessLogRecord struct {
203203
Type string // Type of request (http, https, etc.)
204204
Time string // Timestamp the load balancer generated a response to the client in ISO 8601 format
205205
ELB string // Load balancer resource ID
@@ -235,14 +235,15 @@ type AlbAccessLogRecord struct {
235235
ClassificationReason string // Reason for classification
236236
}
237237

238-
func convertTextToAlbAccessLogRecord(fields []string) (AlbAccessLogRecord, error) {
238+
// convertTextToALBAccessLogRecord converts a slice of strings into a ALBAccessLogRecord
239+
func convertTextToALBAccessLogRecord(fields []string) (ALBAccessLogRecord, error) {
239240
var err error
240241
fieldsCount := len(fields)
241242
if fieldsCount < 29 {
242-
return AlbAccessLogRecord{}, fmt.Errorf("alb access logs do not have enough fields. Expected 29, got %d", fieldsCount)
243+
return ALBAccessLogRecord{}, fmt.Errorf("alb access logs do not have enough fields. Expected 29, got %d", fieldsCount)
243244
}
244245
// Map fields to the struct
245-
record := AlbAccessLogRecord{
246+
record := ALBAccessLogRecord{
246247
Type: fields[0],
247248
Time: fields[1],
248249
ELB: fields[2],

extension/encoding/awslogsencodingextension/internal/unmarshaler/elb-access-log/unmarshaler.go

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -75,17 +75,17 @@ func (f *elbAccessLogUnmarshaler) UnmarshalAWSLogs(reader io.Reader) (plog.Logs,
7575
// Process lines based on determined syntax
7676
switch syntax {
7777
case albAccessLogs:
78-
err = f.handleAlbAccessLogs(fields, resourceAttr, scopeLogs)
78+
err = f.handleALBAccessLogs(fields, resourceAttr, scopeLogs)
7979
if err != nil {
8080
return plog.Logs{}, err
8181
}
8282
case nlbAccessLogs:
83-
err = f.handleNlbAccessLogs(fields, resourceAttr, scopeLogs)
83+
err = f.handleNLBAccessLogs(fields, resourceAttr, scopeLogs)
8484
if err != nil {
8585
return plog.Logs{}, err
8686
}
8787
case clbAccessLogs:
88-
err = f.handleClbAccessLogs(fields, resourceAttr, scopeLogs)
88+
err = f.handleCLBAccessLogs(fields, resourceAttr, scopeLogs)
8989
if err != nil {
9090
return plog.Logs{}, err
9191
}
@@ -134,19 +134,19 @@ func (*elbAccessLogUnmarshaler) setResourceAttributes(r *resourceAttributes, log
134134
attr.PutStr(string(conventions.CloudResourceIDKey), r.resourceID)
135135
}
136136

137-
// handleClbAccessLogs handles clb access logs
138-
func (f *elbAccessLogUnmarshaler) handleClbAccessLogs(fields []string, resourceAttr *resourceAttributes, scopeLogs plog.ScopeLogs) error {
139-
record, err := convertTextToClbAccessLogRecord(fields)
137+
// handleCLBAccessLogs handles clb access logs
138+
func (f *elbAccessLogUnmarshaler) handleCLBAccessLogs(fields []string, resourceAttr *resourceAttributes, scopeLogs plog.ScopeLogs) error {
139+
record, err := convertTextToCLBAccessLogRecord(fields)
140140
if err != nil {
141141
return fmt.Errorf("unable to convert log line to CLB record: %w", err)
142142
}
143-
f.addToClbAccessLogs(resourceAttr, scopeLogs, record)
143+
f.addToCLBAccessLogs(resourceAttr, scopeLogs, record)
144144
return nil
145145
}
146146

147-
// addToClbAccessLogs adds clb record to provided logs based
147+
// addToCLBAccessLogs adds clb record to provided logs based
148148
// on the extracted logs of each resource
149-
func (f *elbAccessLogUnmarshaler) addToClbAccessLogs(resourceAttr *resourceAttributes, scopeLogs plog.ScopeLogs, clbRecord ClbAccessLogRecord) {
149+
func (f *elbAccessLogUnmarshaler) addToCLBAccessLogs(resourceAttr *resourceAttributes, scopeLogs plog.ScopeLogs, clbRecord CLBAccessLogRecord) {
150150
// Convert timestamp first; if invalid, skip log creation
151151
epochNanoseconds, err := convertToUnixEpoch(clbRecord.Time)
152152
if err != nil {
@@ -187,19 +187,19 @@ func (f *elbAccessLogUnmarshaler) addToClbAccessLogs(resourceAttr *resourceAttri
187187
recordLog.MoveTo(rScope)
188188
}
189189

190-
// handleAlbAccessLogs handles alb access logs
191-
func (f *elbAccessLogUnmarshaler) handleAlbAccessLogs(fields []string, resourceAttr *resourceAttributes, scopeLogs plog.ScopeLogs) error {
192-
record, err := convertTextToAlbAccessLogRecord(fields)
190+
// handleALBAccessLogs handles alb access logs
191+
func (f *elbAccessLogUnmarshaler) handleALBAccessLogs(fields []string, resourceAttr *resourceAttributes, scopeLogs plog.ScopeLogs) error {
192+
record, err := convertTextToALBAccessLogRecord(fields)
193193
if err != nil {
194194
return fmt.Errorf("unable to convert log line to ALB record: %w", err)
195195
}
196-
f.addToAlbAccessLogs(resourceAttr, scopeLogs, record)
196+
f.addToALBAccessLogs(resourceAttr, scopeLogs, record)
197197
return nil
198198
}
199199

200-
// addToAlbAccessLogs adds alb record to provided logs based
200+
// addToALBAccessLogs adds alb record to provided logs based
201201
// on the extracted logs of each resource
202-
func (f *elbAccessLogUnmarshaler) addToAlbAccessLogs(resourceAttr *resourceAttributes, scopeLogs plog.ScopeLogs, albRecord AlbAccessLogRecord) {
202+
func (f *elbAccessLogUnmarshaler) addToALBAccessLogs(resourceAttr *resourceAttributes, scopeLogs plog.ScopeLogs, albRecord ALBAccessLogRecord) {
203203
// Convert timestamp first; if invalid, skip log creation
204204
epochNanoseconds, err := convertToUnixEpoch(albRecord.Time)
205205
if err != nil {
@@ -236,19 +236,19 @@ func (f *elbAccessLogUnmarshaler) addToAlbAccessLogs(resourceAttr *resourceAttri
236236
recordLog.MoveTo(rScope)
237237
}
238238

239-
// handleNlbAccessLogs handles nlb access logs
240-
func (f *elbAccessLogUnmarshaler) handleNlbAccessLogs(fields []string, resourceAttr *resourceAttributes, scopeLogs plog.ScopeLogs) error {
241-
record, err := convertTextToNlbAccessLogRecord(fields)
239+
// handleNLBAccessLogs handles nlb access logs
240+
func (f *elbAccessLogUnmarshaler) handleNLBAccessLogs(fields []string, resourceAttr *resourceAttributes, scopeLogs plog.ScopeLogs) error {
241+
record, err := convertTextToNLBAccessLogRecord(fields)
242242
if err != nil {
243243
return fmt.Errorf("unable to convert log line to ALB record: %w", err)
244244
}
245-
f.addToNlbAccessLogs(resourceAttr, scopeLogs, record)
245+
f.addToNLBAccessLogs(resourceAttr, scopeLogs, record)
246246
return nil
247247
}
248248

249-
// addToNlbAccessLogs adds nlb record to provided logs based
249+
// addToNLBAccessLogs adds nlb record to provided logs based
250250
// on the extracted logs of each resource
251-
func (f *elbAccessLogUnmarshaler) addToNlbAccessLogs(resourceAttr *resourceAttributes, scopeLogs plog.ScopeLogs, nlbRecord NlbAccessLogRecord) {
251+
func (f *elbAccessLogUnmarshaler) addToNLBAccessLogs(resourceAttr *resourceAttributes, scopeLogs plog.ScopeLogs, nlbRecord NLBAccessLogRecord) {
252252
// Convert timestamp first; if invalid, skip log creation
253253
epochNanoseconds, err := convertToUnixEpoch(nlbRecord.Time)
254254
if err != nil {

extension/encoding/awslogsencodingextension/internal/unmarshaler/elb-access-log/unmarshaler_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ func readAndCompressLogFile(t *testing.T, dir, file string) io.Reader {
4646
return compressToGZIPReader(t, data)
4747
}
4848

49-
func TestUnmarshallElbAccessLogs(t *testing.T) {
49+
func TestUnmarshallELBAccessLogs(t *testing.T) {
5050
t.Parallel()
5151

5252
filesDirectory := "testdata"

0 commit comments

Comments
 (0)