Skip to content

Commit fef32db

Browse files
authored
[chore] Spelling receiver/s (open-telemetry#37610)
#### Description Fix spelling in receiver/s* open-telemetry#37128 (review) open-telemetry#37134 (comment) #### Link to tracking issue * open-telemetry#37128 --------- Signed-off-by: Josh Soref <[email protected]>
1 parent d7125ca commit fef32db

24 files changed

+37
-37
lines changed

receiver/saphanareceiver/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,5 +99,5 @@ with detailed sample configurations in [testdata/config.yaml](./testdata/config.
9999
100100
Details about the metrics produced by this receiver can be found in [metadata.yaml](./metadata.yaml). Further details of the monitoring queries used to collect them may be found in [queries.go](./queries.go).
101101
102-
> If all of the metrics collected by a given monitoring query are marked as `enabled: false` in the receiver configration, the monitoring query will not be executed.
102+
> If all of the metrics collected by a given monitoring query are marked as `enabled: false` in the receiver configuration, the monitoring query will not be executed.
103103

receiver/saphanareceiver/client_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ func TestBasicConnectAndClose(t *testing.T) {
107107

108108
func TestFailedPing(t *testing.T) {
109109
dbWrapper := &testDBWrapper{}
110-
dbWrapper.On("PingContext").Return(errors.New("Coult not ping host"))
110+
dbWrapper.On("PingContext").Return(errors.New("Could not ping host"))
111111
dbWrapper.On("Close").Return(nil)
112112

113113
factory := &testConnectionFactory{dbWrapper}

receiver/skywalkingreceiver/internal/trace/tracing_report_service.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,13 +83,13 @@ func (r *Receiver) CollectInSync(ctx context.Context, segments *agent.SegmentCol
8383
for _, segment := range segments.Segments {
8484
marshaledSegment, err := proto.Marshal(segment)
8585
if err != nil {
86-
fmt.Printf("cannot marshal segemnt from sync, %v", err)
86+
fmt.Printf("cannot marshal segment from sync, %v", err)
8787
}
8888
err = consumeTraces(ctx, segment, r.nextConsumer)
8989
if err != nil {
9090
fmt.Printf("cannot consume traces, %v", err)
9191
}
92-
fmt.Printf("receivec data:%s", marshaledSegment)
92+
fmt.Printf("received data:%s", marshaledSegment)
9393
}
9494
return &common.Commands{}, nil
9595
}

receiver/skywalkingreceiver/skywalking_receiver.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ type configuration struct {
3939
CollectorGRPCServerSettings configgrpc.ServerConfig
4040
}
4141

42-
// Receiver type is used to receive spans that were originally intended to be sent to Skywaking.
42+
// Receiver type is used to receive spans that were originally intended to be sent to Skywalking.
4343
// This receiver is basically a Skywalking collector.
4444
type swReceiver struct {
4545
config *configuration

receiver/snmpreceiver/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -126,14 +126,14 @@ Attribute configurations are used to define what resource attributes will be use
126126
| -- | -- | -- | -- |
127127
| `oid` | The SNMP scalar OID value to grab data from (must end in .0). | string | |
128128
| `resource_attributes` | The names of the related resource attribute configurations, allowing scalar oid metrics to be added to resources that have one or more scalar oid resource attributes. Cannot have indexed resource attributes as values. | string[] | |
129-
| `attributes` | The names of the related attribute enum configurations as well as the values to attach to this returned SNMP scalar data. This can be used to have a metric config with multiple ScalarOIDs as different datapoints with different attributue values within the same metric | Attribute | |
129+
| `attributes` | The names of the related attribute enum configurations as well as the values to attach to this returned SNMP scalar data. This can be used to have a metric config with multiple ScalarOIDs as different datapoints with different attribute values within the same metric | Attribute | |
130130

131131
#### ColumnOID Configuration
132132

133133
| Field Name | Description | Value | Default |
134134
| -- | -- | -- | -- |
135135
| `oid` | The SNMP scalar OID value to grab data from (must end in .0). | string | |
136-
| `attributes` | The names of the related attribute configurations as well as the enum values to attach to this returned SNMP indexed data if the attribute configuration has enum data. This can be used to attach a specific metric SNMP column OID to an attribute. In doing so, multiple datapoints for a single metric will be created for each returned SNMP indexed data value for the metric along with different attribute values to differentiate them. This also can be used to have a metric config with multiple ColumnOIDs as different datapoints with different attributue values within the same metric | Attribute[] | |
136+
| `attributes` | The names of the related attribute configurations as well as the enum values to attach to this returned SNMP indexed data if the attribute configuration has enum data. This can be used to attach a specific metric SNMP column OID to an attribute. In doing so, multiple datapoints for a single metric will be created for each returned SNMP indexed data value for the metric along with different attribute values to differentiate them. This also can be used to have a metric config with multiple ColumnOIDs as different datapoints with different attribute values within the same metric | Attribute[] | |
137137
| `resource_attributes` | The names of the related resource attribute configurations. This is used to attach a specific metric SNMP column OID to a resource attribute. In doing so, multiple resources will be created for each returned SNMP indexed data value for the metric | string[] | |
138138

139139
#### Attribute

receiver/snmpreceiver/config.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ type AttributeConfig struct {
164164
// This contains a list of possible values that can be associated with this attribute
165165
Enum []string `mapstructure:"enum"`
166166
// OID is required only if Enum and IndexedValuePrefix are not defined.
167-
// This is the column OID which will provide indexed values to be uased for this attribute (alongside a metric with ColumnOIDs)
167+
// This is the column OID which will provide indexed values to be used for this attribute (alongside a metric with ColumnOIDs)
168168
OID string `mapstructure:"oid"`
169169
// IndexedValuePrefix is required only if Enum and OID are not defined.
170170
// This is used alongside metrics with ColumnOIDs to assign attribute values using this prefix + the OID index of the metric value
@@ -190,7 +190,7 @@ type MetricConfig struct {
190190

191191
// GaugeMetric contains info about the value of the gauge metric
192192
type GaugeMetric struct {
193-
// ValueType is required can can be either int or double
193+
// ValueType is required and can be either int or double
194194
ValueType string `mapstructure:"value_type"`
195195
}
196196

@@ -200,7 +200,7 @@ type SumMetric struct {
200200
Aggregation string `mapstructure:"aggregation"`
201201
// Monotonic is required and can be true or false
202202
Monotonic bool `mapstructure:"monotonic"`
203-
// ValueType is required can can be either int or double
203+
// ValueType is required and can be either int or double
204204
ValueType string `mapstructure:"value_type"`
205205
}
206206

receiver/snowflakereceiver/client_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ func TestMetricQueries(t *testing.T) {
218218
{
219219
desc: "FetchSessionMetrics",
220220
query: sessionMetricsQuery,
221-
columns: []string{"username", "disctinct_id"},
221+
columns: []string{"username", "distinct_id"},
222222
params: []driver.Value{"t", 3.0},
223223
expect: sessionMetric{
224224
userName: sql.NullString{

receiver/snowflakereceiver/documentation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -306,7 +306,7 @@ Reported total credits used in the cloud service over the last 24 hour window.
306306
307307
| Name | Description | Values |
308308
| ---- | ----------- | ------ |
309-
| service_type | Service type associateed with metric query. | Any Str |
309+
| service_type | Service type associated with metric query. | Any Str |
310310
311311
### snowflake.billing.total_credit.total
312312
@@ -320,7 +320,7 @@ Reported total credits used across account over the last 24 hour window.
320320
321321
| Name | Description | Values |
322322
| ---- | ----------- | ------ |
323-
| service_type | Service type associateed with metric query. | Any Str |
323+
| service_type | Service type associated with metric query. | Any Str |
324324
325325
### snowflake.billing.virtual_warehouse.total
326326
@@ -334,7 +334,7 @@ Reported total credits used by virtual warehouse service over the last 24 hour w
334334
335335
| Name | Description | Values |
336336
| ---- | ----------- | ------ |
337-
| service_type | Service type associateed with metric query. | Any Str |
337+
| service_type | Service type associated with metric query. | Any Str |
338338
339339
### snowflake.billing.warehouse.cloud_service.total
340340

receiver/snowflakereceiver/factory_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import (
1515
"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/snowflakereceiver/internal/metadata"
1616
)
1717

18-
func TestFacoryCreate(t *testing.T) {
18+
func TestFactoryCreate(t *testing.T) {
1919
factory := NewFactory()
2020
require.EqualValues(t, metadata.Type, factory.Type())
2121
}

receiver/snowflakereceiver/metadata.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ resource_attributes:
1717

1818
attributes:
1919
service_type:
20-
description: Service type associateed with metric query.
20+
description: Service type associated with metric query.
2121
type: string
2222
error_message:
2323
description: Error message reported by query if present.

receiver/snowflakereceiver/scraper_test.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,12 @@ func TestScraper(t *testing.T) {
2727
cfg.Warehouse = "warehouse"
2828
err := component.ValidateConfig(cfg)
2929
if err != nil {
30-
t.Fatal("an error ocured when validating config", err)
30+
t.Fatal("an error occurred when validating config", err)
3131
}
3232

3333
db, mock, err := sqlmock.New(sqlmock.QueryMatcherOption(sqlmock.QueryMatcherEqual))
3434
if err != nil {
35-
t.Fatal("an error ocured when opening mock db", err)
35+
t.Fatal("an error occurred when opening mock db", err)
3636
}
3737
defer db.Close()
3838

@@ -124,7 +124,7 @@ func (m *mockDB) initMockDB() {
124124
},
125125
{
126126
query: sessionMetricsQuery,
127-
columns: []string{"username", "disctinct_id"},
127+
columns: []string{"username", "distinct_id"},
128128
params: []driver.Value{"t", 3.0},
129129
},
130130
{

receiver/solacereceiver/factory.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ import (
1717
)
1818

1919
const (
20-
// default value for max unaked messages
21-
defaultMaxUnaked int32 = 1000
20+
// default value for max unacked messages
21+
defaultMaxUnacked int32 = 1000
2222
// default value for host
2323
defaultHost string = "localhost:5671"
2424
)
@@ -36,7 +36,7 @@ func NewFactory() receiver.Factory {
3636
func createDefaultConfig() component.Config {
3737
return &Config{
3838
Broker: []string{defaultHost},
39-
MaxUnacked: defaultMaxUnaked,
39+
MaxUnacked: defaultMaxUnacked,
4040
Auth: Authentication{},
4141
TLS: configtls.ClientConfig{
4242
InsecureSkipVerify: false,

receiver/solacereceiver/messaging_service.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ func newAMQPMessagingServiceFactory(cfg *Config, logger *zap.Logger) (messagingS
7272
}
7373

7474
type amqpConnectConfig struct {
75-
// conenct config
75+
// connect config
7676
addr string
7777
saslConfig amqp.SASLType
7878
tlsConfig *tls.Config

receiver/solacereceiver/messaging_service_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -504,7 +504,7 @@ func TestAMQPSubstituteVariables(t *testing.T) {
504504

505505
// testFunctionEquality will check that the pointer names are the same for the two functions.
506506
// It is not a perfect comparison but will perform well differentiating between anonymous
507-
// functions and the amqp named functinos
507+
// functions and the amqp named functions
508508
func testFunctionEquality(t *testing.T, f1, f2 any) {
509509
assert.Equal(t, (f1 == nil), (f2 == nil))
510510
if f1 == nil {
@@ -654,7 +654,7 @@ func (c *connMock) Read(b []byte) (n int, err error) {
654654
d := <-c.nextData
655655
// the way this test fixture is designed, there is a race condition
656656
// between write and read where data may be written to nextData on
657-
// a call to Write and may be propogated prior to the return of Write.
657+
// a call to Write and may be propagated prior to the return of Write.
658658
time.Sleep(10 * time.Millisecond)
659659
c.remaining = bytes.NewReader(d)
660660
}

receiver/solacereceiver/receiver.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ const (
4141
)
4242

4343
const (
44-
brokerComponenteNameAttr = "receiver_name"
44+
brokerComponentNameAttr = "receiver_name"
4545
)
4646

4747
// solaceTracesReceiver uses azure AMQP to consume and handle telemetry data from SOlace. Implements receiver.Traces
@@ -88,7 +88,7 @@ func newTracesReceiver(config *Config, set receiver.Settings, nextConsumer consu
8888
receiverName = "solace"
8989
}
9090
solaceBrokerAttrs := attribute.NewSet(
91-
attribute.String(brokerComponenteNameAttr, receiverName),
91+
attribute.String(brokerComponentNameAttr, receiverName),
9292
)
9393

9494
unmarshaller := newTracesUnmarshaller(set.Logger, telemetryBuilder, solaceBrokerAttrs)

receiver/solacereceiver/unmarshaller.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ type tracesUnmarshaller interface {
2525
unmarshal(message *inboundMessage) (ptrace.Traces, error)
2626
}
2727

28-
// newUnmarshalleer returns a new unmarshaller ready for message unmarshalling
28+
// newTracesUnmarshaller returns a new unmarshaller ready for message unmarshalling
2929
func newTracesUnmarshaller(logger *zap.Logger, telemetryBuilder *metadata.TelemetryBuilder, metricAttrs attribute.Set) tracesUnmarshaller {
3030
return &solaceTracesUnmarshaller{
3131
logger: logger,

receiver/solacereceiver/unmarshaller_egress.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ import (
2424
type brokerTraceEgressUnmarshallerV1 struct {
2525
logger *zap.Logger
2626
telemetryBuilder *metadata.TelemetryBuilder
27-
metricAttrs attribute.Set // othere Otel attributes (to add to the metrics)
27+
metricAttrs attribute.Set // other Otel attributes (to add to the metrics)
2828
}
2929

3030
// unmarshal implements tracesUnmarshaller.unmarshal

receiver/solacereceiver/unmarshaller_move.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ import (
2121
type brokerTraceMoveUnmarshallerV1 struct {
2222
logger *zap.Logger
2323
telemetryBuilder *metadata.TelemetryBuilder
24-
metricAttrs attribute.Set // othere Otel attributes (to add to the metrics)
24+
metricAttrs attribute.Set // other Otel attributes (to add to the metrics)
2525
}
2626

2727
// unmarshal implements tracesUnmarshaller.unmarshal

receiver/solacereceiver/unmarshaller_receive.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ func (u *brokerTraceReceiveUnmarshallerV1) mapClientSpanAttributes(spanData *rec
175175
attrMap.PutInt(droppedEnqueueEventsSuccessAttrKey, int64(spanData.DroppedEnqueueEventsSuccess))
176176
attrMap.PutInt(droppedEnqueueEventsFailedAttrKey, int64(spanData.DroppedEnqueueEventsFailed))
177177

178-
// The IPs are now optional meaning we will not incluude them if they are zero length
178+
// The IPs are now optional meaning we will not include them if they are zero length
179179
hostIPLen := len(spanData.HostIp)
180180
if hostIPLen == 4 || hostIPLen == 16 {
181181
attrMap.PutStr(hostIPAttrKey, net.IP(spanData.HostIp).String())
@@ -372,7 +372,7 @@ func (u *brokerTraceReceiveUnmarshallerV1) unmarshalBaggage(toMap pcommon.Map, b
372372
return nil
373373
}
374374

375-
// insertUserProperty will instert a user property value with the given key to an attribute if possible.
375+
// insertUserProperty will insert a user property value with the given key to an attribute if possible.
376376
// Since AttributeMap only supports int64 integer types, uint64 data may be misrepresented.
377377
func (u *brokerTraceReceiveUnmarshallerV1) insertUserProperty(toMap pcommon.Map, key string, value any) {
378378
const (

receiver/solacereceiver/unmarshaller_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ func TestSolaceMessageUnmarshallerUnmarshal(t *testing.T) {
3737
err error
3838
}{
3939
{
40-
name: "Unknown Topic Stirng",
40+
name: "Unknown Topic String",
4141
message: &inboundMessage{
4242
Properties: &amqp.MessageProperties{
4343
To: &invalidTopicString,
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# This powershell script finds all SQLServer counter paths and dumps them to counters.txt.
2-
# This should be run on a system with the a running SQLServer.
2+
# This should be run on a system with a running SQLServer.
33
(Get-Counter -ListSet "SQLServer:*").Paths | Set-Content -Path "$PSScriptRoot\counters.txt"
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# This powershell script finds all SQLServer counter paths and dumps them to counters.txt for a named instance.
2-
# This should be run on a system with the a running SQLServer and named instance.
2+
# This should be run on a system with a running SQLServer and named instance.
33
# This example uses a named instance of TEST_NAME.
44
(Get-Counter -ListSet "MSSQL$*").Paths| Set-Content -Path "$PSScriptRoot\counters.txt"

receiver/sshcheckreceiver/scraper.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ func (s *sshcheckScraper) scrapeSFTP(now pcommon.Timestamp) error {
6363
return err
6464
}
6565

66-
// timeout chooses the shorter between between a given deadline and timeout
66+
// timeout chooses the shorter duration between a given deadline and timeout
6767
func timeout(deadline time.Time, timeout time.Duration) time.Duration {
6868
timeToDeadline := time.Until(deadline)
6969
if timeToDeadline < timeout {

receiver/syslogreceiver/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Parses Syslogs received over TCP or UDP.
2222
| `udp` | `nil` | Defined udp_input operator. (see the UDP configuration section) |
2323
| `protocol` | required | The protocol to parse the syslog messages as. Options are `rfc3164` and `rfc5424` |
2424
| `location` | `UTC` | The geographic location (timezone) to use when parsing the timestamp (Syslog RFC 3164 only). The available locations depend on the local IANA Time Zone database. [This page](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) contains many examples, such as `America/New_York`. |
25-
| `enable_octet_counting` | `false` | Wether or not to enable [RFC 6587](https://www.rfc-editor.org/rfc/rfc6587#section-3.4.1) Octet Counting on syslog parsing (Syslog RFC 5424 and TCP only). |
25+
| `enable_octet_counting` | `false` | Whether or not to enable [RFC 6587](https://www.rfc-editor.org/rfc/rfc6587#section-3.4.1) Octet Counting on syslog parsing (Syslog RFC 5424 and TCP only). |
2626
| `max_octets` | `8192` | The maximum octets for messages using [RFC 6587](https://www.rfc-editor.org/rfc/rfc6587#section-3.4.1) Octet Counting on syslog parsing (Syslog RFC 5424 and TCP only). |
2727
| `allow_skip_pri_header` | `false` | Allow parsing records without the PRI header. If this setting is enabled, messages without the PRI header will be successfully parsed. The `SeverityNumber` and `SeverityText` fields as well as the `priority` and `facility` attributes will not be set on the log record. If this setting is disabled (the default), messages without PRI header will throw an exception. To set this setting to `true`, the `enable_octet_counting` setting must be `false`. |
2828
| `non_transparent_framing_trailer` | `nil` | The framing trailer, either `LF` or `NUL`, when using [RFC 6587](https://www.rfc-editor.org/rfc/rfc6587#section-3.4.2) Non-Transparent-Framing (Syslog RFC 5424 and TCP only). |

0 commit comments

Comments
 (0)