Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions .chloggen/add-alias-for-otlphttp-exporter.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Use this changelog template to create an entry for release notes.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: deprecation

# The name of the component, or a single word describing the area of concern, (e.g. receiver/otlp)
component: exporter/otlp_http

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Rename `otlphttp` exporter to `otlp_http` exporter and add deprecated alias `otlphttp`.

# One or more tracking issues or pull requests related to the change
issues: [14396]

# (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:

# 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: []
2 changes: 1 addition & 1 deletion .chloggen/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ components:
- exporter/debug
- exporter/nop
- exporter/otlp
- exporter/otlphttp
- exporter/otlp_http
- extension/memory_limiter
- extension/xextension
- extension/xextension
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ body:
- exporter/exporterhelper/xexporterhelper
- exporter/nop
- exporter/otlp
- exporter/otlphttp
- exporter/otlp_http
- exporter/x
- extension/memorylimiter
- extension/x
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ body:
- exporter/exporterhelper/xexporterhelper
- exporter/nop
- exporter/otlp
- exporter/otlphttp
- exporter/otlp_http
- exporter/x
- extension/memorylimiter
- extension/x
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/other.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ body:
- exporter/exporterhelper/xexporterhelper
- exporter/nop
- exporter/otlp
- exporter/otlphttp
- exporter/otlp_http
- exporter/x
- extension/memorylimiter
- extension/x
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/utils/cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -353,6 +353,7 @@
"otelzap",
"otlpexporter",
"otlpgrpc",
"otlp_http",
"otlphttp",
"otlphttpexporter",
"otlphttpexporter's",
Expand Down
1 change: 1 addition & 0 deletions component/identifiable_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,7 @@ func TestNewType(t *testing.T) {
{name: "oteltestbedcol"},
{name: "otlp"},
{name: "otlp_encoding"},
{name: "otlp_http"},
{name: "otlphttp"},
{name: "otlpjsonfile"},
{name: "ottl"},
Expand Down
2 changes: 1 addition & 1 deletion config/configauth/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ receivers:
## oidc is the extension name to use as the authenticator for this receiver
authenticator: oidc

otlphttp/withauth:
otlp_http/withauth:
endpoint: http://localhost:9000
auth:
authenticator: oauth2client
Expand Down
2 changes: 1 addition & 1 deletion config/confighttp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Example:

```yaml
exporter:
otlphttp:
otlp_http:
endpoint: otelcol2:55690
auth:
authenticator: some-authenticator-extension
Expand Down
2 changes: 1 addition & 1 deletion confmap/provider/yamlprovider/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,5 @@ The YAML Provider takes a literal YAML string as Collector configuration.
The scheme for this provider is `yaml`. Usage looks like the following passed to the Collector's command line invocation:

```text
--config="yaml:exporters::otlphttp::sending_queue::batch::flush_timeout: 2s"
--config="yaml:exporters::otlp_http::sending_queue::batch::flush_timeout: 2s"
```
4 changes: 2 additions & 2 deletions confmap/provider/yamlprovider/provider.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ type provider struct{}
// bytes-uri = "yaml:" yaml-bytes
//
// Examples:
// `yaml:exporters::otlphttp::sending_queue::batch::flush_timeout: 2s`
// `yaml:exporters::otlphttp/foo::sending_queue::batch::flush_timeout: 2s`
// `yaml:exporters::otlp_http::sending_queue::batch::flush_timeout: 2s`
// `yaml:exporters::otlp_http/foo::sending_queue::batch::flush_timeout: 2s`
func NewFactory() confmap.ProviderFactory {
return confmap.NewProviderFactory(newProvider)
}
Expand Down
11 changes: 7 additions & 4 deletions exporter/otlphttpexporter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,13 @@
[otlp]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-otlp
<!-- end autogenerated section -->

Export traces and/or metrics via HTTP using [OTLP](
The `otlp_http` exporter sends logs, metrics, profiles and traces via HTTP using [OTLP](
https://github.com/open-telemetry/opentelemetry-proto/blob/main/docs/specification.md)
format.

The `otlphttp` deprecated alias exists for the component name. It will be removed in a future version.
If you use the deprecated alias `otlphttp` in your configuration, change it to `otlp_http`.

The following settings are required:

- `endpoint` (no default): The target base URL to send data to (e.g.: https://example.com:4318).
Expand Down Expand Up @@ -48,15 +51,15 @@ Example:

```yaml
exporters:
otlphttp:
otlp_http:
endpoint: https://example.com:4318
```

By default `gzip` compression is enabled. See [compression comparison](../../config/configgrpc/README.md#compression-comparison) for details benchmark information. To disable, configure as follows:

```yaml
exporters:
otlphttp:
otlp_http:
...
compression: none
```
Expand All @@ -65,7 +68,7 @@ By default `proto` encoding is used, to change the content encoding of the messa

```yaml
exporters:
otlphttp:
otlp_http:
...
encoding: json
```
Expand Down
1 change: 1 addition & 0 deletions exporter/otlphttpexporter/factory.go
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ func NewFactory() exporter.Factory {
return xexporter.NewFactory(
metadata.Type,
createDefaultConfig,
xexporter.WithDeprecatedTypeAlias(component.MustNewType("otlphttp")),
xexporter.WithTraces(createTraces, metadata.TracesStability),
xexporter.WithMetrics(createMetrics, metadata.MetricsStability),
xexporter.WithLogs(createLogs, metadata.LogsStability),
Expand Down
2 changes: 1 addition & 1 deletion exporter/otlphttpexporter/generated_component_test.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion exporter/otlphttpexporter/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
type: otlphttp
type: otlp_http
github_project: open-telemetry/opentelemetry-collector

status:
Expand Down
4 changes: 2 additions & 2 deletions exporter/otlphttpexporter/testdata/bad_empty_config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ processors:
nop:

exporters:
otlphttp:
otlp_http:

service:
pipelines:
traces:
receivers: [nop]
processors: [nop]
exporters: [otlphttp]
exporters: [otlp_http]
2 changes: 1 addition & 1 deletion internal/e2e/error_propagation_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ func createHTTPExporter(t *testing.T, code int) consumer.Logs {
cfg.RetryConfig.Enabled = false
cfg.Encoding = otlphttpexporter.EncodingProto
cfg.LogsEndpoint = srv.URL + "/v1/logs"
e, err := f.CreateLogs(context.Background(), exportertest.NewNopSettings(component.MustNewType("otlphttp")), cfg)
e, err := f.CreateLogs(context.Background(), exportertest.NewNopSettings(component.MustNewType("otlp_http")), cfg)
require.NoError(t, err)
err = e.Start(context.Background(), componenttest.NewNopHost())
require.NoError(t, err)
Expand Down
2 changes: 1 addition & 1 deletion reports/distributions/contrib.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ components:
- debug
- nop
- otlp
- otlphttp
- otlp_http
extension:
- zpages
pkg:
Expand Down
2 changes: 1 addition & 1 deletion reports/distributions/core.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ components:
- debug
- nop
- otlp
- otlphttp
- otlp_http
extension:
- zpages
pkg:
Expand Down
2 changes: 1 addition & 1 deletion reports/distributions/k8s.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ components:
- debug
- nop
- otlp
- otlphttp
- otlp_http
extension:
- zpages
processor:
Expand Down
2 changes: 1 addition & 1 deletion reports/distributions/otlp.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ maintainers: []
components:
exporter:
- otlp
- otlphttp
- otlp_http
receiver:
- otlp
2 changes: 1 addition & 1 deletion service/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ processors:
- memory_limiter
exporters:
- otlp
- otlphttp
- otlp_http
- debug
extensions:
- zpages
Expand Down
Loading