diff --git a/exporter/exporterhelper/doc.go b/exporter/exporterhelper/doc.go new file mode 100644 index 00000000000..6cd2d2c4cfe --- /dev/null +++ b/exporter/exporterhelper/doc.go @@ -0,0 +1,16 @@ +// Copyright The OpenTelemetry Authors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Package exporterhelper provides helper functions for exporters. +package exporterhelper diff --git a/exporter/fileexporter/doc.go b/exporter/fileexporter/doc.go new file mode 100644 index 00000000000..1988008f57f --- /dev/null +++ b/exporter/fileexporter/doc.go @@ -0,0 +1,16 @@ +// Copyright The OpenTelemetry Authors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Package fileexporter exports data to files. +package fileexporter diff --git a/exporter/jaegerexporter/doc.go b/exporter/jaegerexporter/doc.go index e66a34822ad..aafcbf18c89 100644 --- a/exporter/jaegerexporter/doc.go +++ b/exporter/jaegerexporter/doc.go @@ -12,6 +12,5 @@ // See the License for the specific language governing permissions and // limitations under the License. -// Package jaegerexporter implements an exporter that sends trace data to -// a Jaeger collector gRPC endpoint. +// Package jaegerexporter sends trace data to a Jaeger Collector gRPC endpoint. package jaegerexporter diff --git a/exporter/kafkaexporter/doc.go b/exporter/kafkaexporter/doc.go new file mode 100644 index 00000000000..d41ea08fb37 --- /dev/null +++ b/exporter/kafkaexporter/doc.go @@ -0,0 +1,16 @@ +// Copyright The OpenTelemetry Authors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Package kafkaexporter exports trace data to Kafka. +package kafkaexporter diff --git a/exporter/loggingexporter/doc.go b/exporter/loggingexporter/doc.go new file mode 100644 index 00000000000..d6652178b27 --- /dev/null +++ b/exporter/loggingexporter/doc.go @@ -0,0 +1,16 @@ +// Copyright The OpenTelemetry Authors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Package loggingexporter exports data to console as logs. +package loggingexporter diff --git a/exporter/opencensusexporter/doc.go b/exporter/opencensusexporter/doc.go new file mode 100644 index 00000000000..13cb23b5bb8 --- /dev/null +++ b/exporter/opencensusexporter/doc.go @@ -0,0 +1,16 @@ +// Copyright The OpenTelemetry Authors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Package opencensusexporter exports data to an OpenCensus agent. +package opencensusexporter diff --git a/exporter/otlpexporter/doc.go b/exporter/otlpexporter/doc.go new file mode 100644 index 00000000000..41d4b7662fa --- /dev/null +++ b/exporter/otlpexporter/doc.go @@ -0,0 +1,16 @@ +// Copyright The OpenTelemetry Authors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Package otlpexporter exports data by using the OTLP format to a gPRC endpoint. +package otlpexporter diff --git a/exporter/otlphttpexporter/doc.go b/exporter/otlphttpexporter/doc.go new file mode 100644 index 00000000000..816df31ac35 --- /dev/null +++ b/exporter/otlphttpexporter/doc.go @@ -0,0 +1,16 @@ +// Copyright The OpenTelemetry Authors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Package otlphttpexporter exports data by using the OTLP format to an HTTP endpoint. +package otlphttpexporter diff --git a/exporter/prometheusexporter/doc.go b/exporter/prometheusexporter/doc.go new file mode 100644 index 00000000000..d193c39fea4 --- /dev/null +++ b/exporter/prometheusexporter/doc.go @@ -0,0 +1,16 @@ +// Copyright The OpenTelemetry Authors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Package prometheusexporter exports metrics data as a Prometheus pull handler. +package prometheusexporter diff --git a/exporter/prometheusremotewriteexporter/doc.go b/exporter/prometheusremotewriteexporter/doc.go new file mode 100644 index 00000000000..fc02fadc5c1 --- /dev/null +++ b/exporter/prometheusremotewriteexporter/doc.go @@ -0,0 +1,16 @@ +// Copyright The OpenTelemetry Authors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Package prometheusremotewriteexporter sends metrics data to Prometheus Remote Write (PRW) endpoints. +package prometheusremotewriteexporter diff --git a/exporter/prometheusremotewriteexporter/exporter.go b/exporter/prometheusremotewriteexporter/exporter.go index 1995ad826ba..be41159d51a 100644 --- a/exporter/prometheusremotewriteexporter/exporter.go +++ b/exporter/prometheusremotewriteexporter/exporter.go @@ -12,7 +12,6 @@ // See the License for the specific language governing permissions and // limitations under the License. -// Package prometheusremotewriteexporter implements an exporter that sends Prometheus remote write requests. package prometheusremotewriteexporter import ( diff --git a/exporter/zipkinexporter/doc.go b/exporter/zipkinexporter/doc.go new file mode 100644 index 00000000000..488f0ca1209 --- /dev/null +++ b/exporter/zipkinexporter/doc.go @@ -0,0 +1,16 @@ +// Copyright The OpenTelemetry Authors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Package zipkinexporter exports trace data to Zipkin. +package zipkinexporter