Skip to content

Commit

Permalink
fill in with suggestions where possible
Browse files Browse the repository at this point in the history
  • Loading branch information
colleenmcginnis committed Jul 17, 2024
1 parent cb69190 commit cf8917c
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 22 deletions.
22 changes: 9 additions & 13 deletions docs/configure.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,10 @@ Environment variables are read at startup and can be used to configure the Elast
For details of the various options available and their corresponding environment variable names,
see <<configure-configuration-options>>.

// TO DO: Example

// ✅ Order of operations
// Order of operations
//
// TO DO: What if a configuration option is set manually in the code?
// Would that take precedence over environment variables and/or the `IConfiguration` system?
Environment variables always take precedence over configuration provided by the `IConfiguration`
system.

Expand Down Expand Up @@ -95,7 +96,6 @@ For example, you can define the configuration for the Elastic Distribution for O
----
<1> This example sets the file log directory to `C:\Logs` which enables diagnostic file logging.

// ✅ Order of operations
Configuration from the "Elastic:OpenTelemetry" section of the `IConfiguration` instance will be
bound to the `ElasticOpenTelemetryOptions` instance used to configure the Elastic distribution.

Expand Down Expand Up @@ -147,8 +147,6 @@ setting the corresponding property.
<4> Pass the `ElasticOpenTelemetryBuilderOptions` instance to the `ElasticOpenTelemetryBuilder` constructor
to configure the Elastic Distribution for OpenTelemetry .NET.

// TO DO: Order of operations

////
✅ List all available configuration options
////
Expand Down Expand Up @@ -281,13 +279,13 @@ When sending data to Elastic, there are two ways you can authenticate: using a s
[[configure-secret-token]]
==== Use a secret token

// TO DO:What is this?
// TO DO: What is this?
// ??

// TO DO:Why would you choose this method?
// TO DO: Why would you choose this method?
// ??

// TO DO:How do you authenticate using this method?
// TO DO: How do you authenticate using this method?
// ??

[discrete]
Expand All @@ -298,7 +296,7 @@ When sending data to Elastic, there are two ways you can authenticate: using a s
It is also possible to authenticate to an Elastic Observability endpoint using
an _APM agent key_. These are revocable API keys.

// TO DO:Why would you choose this method?
// TO DO: Why would you choose this method?
// ??

// ✅ How do you authenticate using this method?
Expand All @@ -310,9 +308,7 @@ To create and manage APM Agent keys in Kibana:
When using an APM Agent key, the `OTEL_EXPORTER_OTLP_HEADERS` is set using a
different auth schema (`ApiKey` rather than `Bearer`). For example:

////
TO DO:Code example
////
// TO DO: Code example

:!language:
:!language_lc:
Expand Down
18 changes: 9 additions & 9 deletions docs/get-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -250,25 +250,25 @@ For more information on all the available configuration options, refer to <<conf
To view the traces, you can use the Elastic APM UI:

////
TO DO: Step-by-step instructions
TO DO: Verify step-by-step instructions
////
In {kib}:

. Go to *APM* -> *Traces*.
. You should see the service you just started tracking.
. Click on the name in the list to see traces.

image:images/trace-sample-minimal-api.png[Minimal API request trace sample in the Elastic APM UI]

////
TO DO: What should they do next?
What they should do next
////
[discrete]
[[get-started-next-steps]]
=== Next steps

////
// Examples:
//
// See all configuration options
// Learn more about interpreting data
// Other
////
* Browse all <<configure,distro configuration options>>.
* Learn more about viewing and interpreting data in the {observability-guide}/apm.html[Observability guide].

:!language:
:!language_lc:
Expand Down

0 comments on commit cf8917c

Please sign in to comment.