Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add registry tip to ocb #5028

Merged
merged 10 commits into from
Sep 30, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
14 changes: 10 additions & 4 deletions content/en/docs/collector/custom-collector.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,8 +119,6 @@ the development and testing of components.
Go ahead and create a manifest file named `builder-config.yaml` with the
following content:

> builder-config.yaml

```yaml
dist:
name: otelcol-dev
Expand All @@ -143,8 +141,6 @@ collector distribution:
The `builder-config.yaml` manifest file will look like this after adding the
components:

> builder-config.yaml

<!-- prettier-ignore -->
```yaml
dist:
Expand All @@ -169,6 +165,16 @@ receivers:
go.opentelemetry.io/collector/receiver/otlpreceiver {{% version-from-registry collector-receiver-otlp %}}
```

{{% alert color="primary" title="Tip" %}}

To find components that you can add to your collector component, take a look
svrnm marked this conversation as resolved.
Show resolved Hide resolved
into the
[OpenTelemetry Registry](https://opentelemetry.io/ecosystem/registry/?language=collector).
You will not only find what is available, but also the full string you need to
add to your `builder-config.yaml`.
svrnm marked this conversation as resolved.
Show resolved Hide resolved

{{% /alert %}}

## Step 3 - Generating the Code and Building your Collector's distribution

All you need now is to let the `ocb` do it's job, so go to your terminal and
Expand Down
6 changes: 5 additions & 1 deletion data/registry/collector-exporter-apiclarity.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# cSpell:ignore apiclarity
# cSpell:ignore apiclarity apiclarityexporter openclarity
title: APIClarity HTTP Exporter
registryType: exporter
language: collector
Expand All @@ -11,7 +11,11 @@
description:
Exports traces and/or metrics via HTTP to an APIClarity endpoint for analysis.
authors:
- name: Cisco Systems

Check warning on line 14 in data/registry/collector-exporter-apiclarity.yml

View workflow job for this annotation

GitHub Actions / REGISTRY validation

Registry Schema Validation

An author must have an email or a URL

Check notice on line 14 in data/registry/collector-exporter-apiclarity.yml

View workflow job for this annotation

GitHub Actions / REGISTRY validation

Registry Schema Validation

must match "else" schema
urls:
repo: https://github.com/openclarity/apiclarity/tree/master/plugins/otel-collector
createdAt: 2022-11-28
package:
name: github.com/openclarity/apiclarity/plugins/otel-collector/apiclarityexporter
registry: go-collector
version: v0.0.0
4 changes: 4 additions & 0 deletions static/refcache.json
Original file line number Diff line number Diff line change
Expand Up @@ -7971,6 +7971,10 @@
"StatusCode": 200,
"LastSeen": "2024-08-09T11:01:13.220618-04:00"
},
"https://pkg.go.dev/github.com/openclarity/apiclarity/plugins/otel-collector/apiclarityexporter": {
"StatusCode": 200,
"LastSeen": "2024-08-12T17:56:07.964057+02:00"
},
"https://pkg.go.dev/go.opentelemetry.io/collector/cmd/builder": {
"StatusCode": 200,
"LastSeen": "2024-03-01T16:49:30.684687+01:00"
Expand Down
Loading