Skip to content

Commit

Permalink
Tidy up, regenerate go.sum, docs
Browse files Browse the repository at this point in the history
Signed-off-by: Paschalis Tsilias <[email protected]>
  • Loading branch information
tpaschalis committed Feb 20, 2024
1 parent 38a1866 commit 4279489
Show file tree
Hide file tree
Showing 6 changed files with 35 additions and 35 deletions.
7 changes: 4 additions & 3 deletions component/otelcol/receiver/awsfirehose/awsfirehose.go
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
// Package awsfirehose provides an otelcol.receiver.awsfirehose component.
// Package awsfirehose provides an otelcol.receiver.aws_firehose component.
package awsfirehose

import (
"github.com/grafana/agent/component"
"github.com/grafana/agent/component/otelcol"
"github.com/grafana/agent/component/otelcol/receiver"
"github.com/grafana/river/rivertypes"
"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/awsfirehosereceiver"
otelcomponent "go.opentelemetry.io/collector/component"
"go.opentelemetry.io/collector/config/configopaque"
Expand All @@ -13,7 +14,7 @@ import (

func init() {
component.Register(component.Registration{
Name: "otelcol.receiver.awsfirehose",
Name: "otelcol.receiver.aws_firehose",
Args: Arguments{},

Build: func(opts component.Options, args component.Arguments) (component.Component, error) {
Expand All @@ -31,7 +32,7 @@ type Arguments struct {
RecordType string `river:"record_type,attr,optional"`

// The access key to be checked on each request received.
AccessKey string `river:"access_key,attr,optional"`
AccessKey rivertypes.Secret `river:"access_key,attr,optional"`

HTTPServer otelcol.HTTPServerArguments `river:",squash"`

Expand Down
1 change: 1 addition & 0 deletions docs/sources/flow/reference/compatibility/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -323,6 +323,7 @@ The following components, grouped by namespace, _consume_ OpenTelemetry `otelcol
- [otelcol.processor.span]({{< relref "../components/otelcol.processor.span.md" >}})
- [otelcol.processor.tail_sampling]({{< relref "../components/otelcol.processor.tail_sampling.md" >}})
- [otelcol.processor.transform]({{< relref "../components/otelcol.processor.transform.md" >}})
- [otelcol.receiver.aws_firehose]({{< relref "../components/otelcol.receiver.aws_firehose.md" >}})
- [otelcol.receiver.jaeger]({{< relref "../components/otelcol.receiver.jaeger.md" >}})
- [otelcol.receiver.kafka]({{< relref "../components/otelcol.receiver.kafka.md" >}})
- [otelcol.receiver.loki]({{< relref "../components/otelcol.receiver.loki.md" >}})
Expand Down
42 changes: 21 additions & 21 deletions docs/sources/flow/reference/components/loki.source.awsfirehose.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
---
aliases:
- /docs/grafana-cloud/agent/flow/reference/components/loki.source.awsfirehose/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/reference/components/loki.source.awsfirehose/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/reference/components/loki.source.awsfirehose/
- /docs/grafana-cloud/send-data/agent/flow/reference/components/loki.source.awsfirehose/
canonical: https://grafana.com/docs/agent/latest/flow/reference/components/loki.source.awsfirehose/
description: Learn about loki.source.awsfirehose
title: loki.source.awsfirehose
- /docs/grafana-cloud/agent/flow/reference/components/loki.source.aws_firehose/
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/reference/components/loki.source.aws_firehose/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/reference/components/loki.source.aws_firehose/
- /docs/grafana-cloud/send-data/agent/flow/reference/components/loki.source.aws_firehose/
canonical: https://grafana.com/docs/agent/latest/flow/reference/components/loki.source.aws_firehose/
description: Learn about loki.source.aws_firehose
title: loki.source.aws_firehose
---

# loki.source.awsfirehose
# loki.source.aws_firehose

`loki.source.awsfirehose` receives log entries over HTTP
`loki.source.aws_firehose` receives log entries over HTTP
from [AWS Firehose](https://docs.aws.amazon.com/firehose/latest/dev/what-is-this-service.html)
and forwards them to other `loki.*` components.

Expand Down Expand Up @@ -57,7 +57,7 @@ See [Examples](#example) for a full example configuration showing how to enrich
## Usage

```river
loki.source.awsfirehose "LABEL" {
loki.source.aws_firehose "LABEL" {
http {
listen_address = "LISTEN_ADDRESS"
listen_port = PORT
Expand All @@ -68,12 +68,12 @@ loki.source.awsfirehose "LABEL" {

The component will start an HTTP server on the configured port and address with the following endpoints:

- `/awsfirehose/api/v1/push` - accepting `POST` requests compatible
- `/aws_firehose/api/v1/push` - accepting `POST` requests compatible
with [AWS Firehose HTTP Specifications](https://docs.aws.amazon.com/firehose/latest/dev/httpdeliveryrequestresponse.html).

## Arguments

`loki.source.awsfirehose` supports the following arguments:
`loki.source.aws_firehose` supports the following arguments:

| Name | Type | Description | Default | Required |
| ------------------------ | -------------------- | -------------------------------------------------------------- | ------- | -------- |
Expand All @@ -90,7 +90,7 @@ to the list of receivers in `forward_to`.

## Blocks

The following blocks are supported inside the definition of `loki.source.awsfirehose`:
The following blocks are supported inside the definition of `loki.source.aws_firehose`:

| Hierarchy | Name | Description | Required |
|-----------|----------|----------------------------------------------------|----------|
Expand All @@ -111,11 +111,11 @@ The following blocks are supported inside the definition of `loki.source.awsfire

## Exported fields

`loki.source.awsfirehose` does not export any fields.
`loki.source.aws_firehose` does not export any fields.

## Component health

`loki.source.awsfirehose` is only reported as unhealthy if given an invalid configuration.
`loki.source.aws_firehose` is only reported as unhealthy if given an invalid configuration.

## Debug metrics

Expand All @@ -124,10 +124,10 @@ The following are some of the metrics that are exposed when this component is us
The metrics include labels such as `status_code` where relevant, which you can use to measure request success rates.
{{< /admonition >}}

- `loki_source_awsfirehose_request_errors` (counter): Count of errors while receiving a request.
- `loki_source_awsfirehose_record_errors` (counter): Count of errors while decoding an individual record.
- `loki_source_awsfirehose_records_received` (counter): Count of records received.
- `loki_source_awsfirehose_batch_size` (histogram): Size (in units) of the number of records received per request.
- `loki_source_aws_firehose_request_errors` (counter): Count of errors while receiving a request.
- `loki_source_aws_firehose_record_errors` (counter): Count of errors while decoding an individual record.
- `loki_source_aws_firehose_records_received` (counter): Count of records received.
- `loki_source_aws_firehose_batch_size` (histogram): Size (in units) of the number of records received per request.

## Example

Expand All @@ -146,7 +146,7 @@ loki.write "local" {
}
}
loki.source.awsfirehose "loki_fh_receiver" {
loki.source.aws_firehose "loki_fh_receiver" {
http {
listen_address = "0.0.0.0"
listen_port = 9999
Expand All @@ -172,7 +172,7 @@ loki.write "local" {
}
}
loki.source.awsfirehose "loki_fh_receiver" {
loki.source.aws_firehose "loki_fh_receiver" {
http {
listen_address = "0.0.0.0"
listen_port = 9999
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ otelcol.receiver.awsfirehose "LABEL" {
Name | Type | Description | Default | Required
---- | ---- | ----------- | ------- | --------
`record_type` | `string` | The type of record received from the delivery stream. | `cwmetrics` | no
`access_key` | `string` | The access key to be checked on each request received. | | no
`access_key` | `secret` | The access key to be checked on each request received. | | no
`endpoint` | `string` | `host:port` to listen for traffic on. | `"0.0.0.0:4433"` | no
`max_request_body_size` | `string` | Maximum request body size the HTTP server will allow. No limit when unset. | | no
`include_metadata` | `boolean` | Propagate incoming connection metadata to downstream consumers. | | no
Expand Down Expand Up @@ -151,16 +151,14 @@ otelcol.exporter.otlp "default" {

## Compatible components

`otelcol.receiver.awsfirehose` can accept arguments from the following components:
`otelcol.receiver.aws_firehose` can accept arguments from the following components:

- Components that export [OpenTelemetry `otelcol.Consumer`]({{< relref "../compatibility/#opentelemetry-otelcolconsumer-exporters" >}})


{{% admonition type="note" %}}

Connecting some components may not be sensible or components may require further configuration to make the
connection work correctly. Refer to the linked documentation for more details.

{{% /admonition %}}
{{< admonition type="note" >}}
Connecting some components may not be sensible or components may require further configuration to make the connection work correctly.
Refer to the linked documentation for more details.
{{< /admonition >}}

<!-- END GENERATED COMPATIBLE COMPONENTS -->
<!-- END GENERATED COMPATIBLE COMPONENTS -->
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -603,7 +603,7 @@ require (
sigs.k8s.io/structured-merge-diff/v4 v4.3.0 // indirect
)

require github.com/ianlancetaylor/demangle v0.0.0-20230524184225-eabc099b10ab
require github.com/ianlancetaylor/demangle v0.0.0-20230524184225-eabc099b10ab // indirect

require (
connectrpc.com/connect v1.14.0
Expand Down
2 changes: 1 addition & 1 deletion go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -1352,7 +1352,7 @@ github.com/jackc/puddle v0.0.0-20190413234325-e4ced69a3a2b/go.mod h1:m4B5Dj62Y0f
github.com/jackc/puddle v0.0.0-20190608224051-11cab39313c9/go.mod h1:m4B5Dj62Y0fbyuIc15OsIqK0+JU8nkqQjsgx7dvjSWk=
github.com/jackc/puddle v1.1.3/go.mod h1:m4B5Dj62Y0fbyuIc15OsIqK0+JU8nkqQjsgx7dvjSWk=
github.com/jackc/puddle v1.3.0/go.mod h1:m4B5Dj62Y0fbyuIc15OsIqK0+JU8nkqQjsgx7dvjSWk=
github.com/jaegertracing/jaeger v1.50.0 h1:fCfMXCJzK0feJrzDDXcgNVtc2pjUFfRSAIpsVCikKCc=
github.com/jaegertracing/jaeger v1.50.0 h1:qsOcPeB3nAc3h8tx+gnZ3JODAZfqbYmQr45jPEwBd2w=
github.com/jaegertracing/jaeger v1.50.0/go.mod h1:MVGvxf4+Pcn31gz9RnLo0097w3khKFwJIprIZHOt89s=
github.com/jarcoal/httpmock v0.0.0-20180424175123-9c70cfe4a1da/go.mod h1:ks+b9deReOc7jgqp+e7LuFiCBH6Rm5hL32cLcEAArb4=
github.com/jarcoal/httpmock v1.3.0 h1:2RJ8GP0IIaWwcC9Fp2BmVi8Kog3v2Hn7VXM3fTd+nuc=
Expand Down

0 comments on commit 4279489

Please sign in to comment.