Add better documentation for IResourceDetector and OltpExporter configuration

[cromefire]

Fixes #4228.

Changes

• Adds more documentation to make the configurability of the OLTP exporter more clear.
• Better documentation for the IResourceDetector

For significant contributions please make sure you have completed the following items:

• Appropriate CHANGELOG.md updated for non-trivial changes
• Design discussion issue Pass the IServiceProvider in ConfigureResource, WithTracing & WithMetrics #4228
• Changes in public API reviewed

[reyang]

@cromefire would you update the PR title please? (this PR is exposing new API, which is more than "add better documentation")

[cromefire]

Also added #4139 to the fixes list.

[cijothomas]

Blocking temporarily to prevent accidental merges, as we are in the process of stable release. Will unblock once the release process is done.

1.4 release work is done.

[cromefire]

Made this into the PR for the documentation

[github-actions]

This PR was marked stale due to lack of activity and will be closed in 7 days. Commenting or Pushing will instruct the bot to automatically remove the label. This bot runs once per day.

[cromefire]

Just waiting for merge, bot

[github-actions]

This PR was marked stale due to lack of activity and will be closed in 7 days. Commenting or Pushing will instruct the bot to automatically remove the label. This bot runs once per day.

[cromefire]

Go away bot, still waiting for merge.

[CodeBlanch]

What if we made this slightly more interesting by showing something being injected?

public class MyResourceDetector : IResourceDetector
{
    private readonly IWebHostEnvironment webHostEnvironment;

    public MyResourceDetector(IWebHostEnvironment webHostEnvironment)
    {
        this.webHostEnvironment = webHostEnvironment;
    }

    public Resource Detect()
    {
        return ResourceBuilder.CreateEmpty()
            .AddService(serviceName: this.webHostEnvironment.ApplicationName)
            .AddAttributes(new Dictionary<string, object> { ["host.environment"] = this.webHostEnvironment.EnvironmentName })
            .Build();
    }
}

[cromefire]

The environment is injected, I can add something else too if you want.

[CodeBlanch]

@cromefire I don't see any changes on the diff did you forget to push maybe? 😄

[cromefire]

No I'm just too stupid to use the GitHub app... Will fix

[cromefire]

Fixed

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: cromefire / name: Cromefire_ (145ff7f, 5c86fc1, c6dc65d, b7f6156, 12ef20c, 5da158c, 796cad8, dbbe47f, 7e5ef07, b53a42c, 2c242c5, 7415513, c68f85b, 2847aa6, 2b4831b, 261ea06, c7c6d09, 290d486, ba2edeb, 11a81a3, f7f0488, 6d81fe4, 9a189f2, 31fc495)
• ✅ login: cijothomas / name: Cijo Thomas (138fff0)

[CodeBlanch]

LGTM