Tags Configuration Documenation

[eavestn]

Description

I would like to take advantage of the tags listed in the Integrations section of the documentation.

Issue

How to configure the tags is not explicitly addressed in the documentation, e.g. should a configuration object be passed that specifies both service and tags when initializing the span?

tracer
  .trace('web.request', {
    service: 'my_service',
    tags: { 
       // ...
    }
  })

[eavestn]

I could look at the code; however, for more enterprise-y integrations, listing this will help people feel more confident in the library, itself, I believe.

[rochdev]

@eavestn Actually, these are tags that are automatically added by the integration, so there is nothing to do on your part to get them.

It seems the documentation is not clear on what the listed tags are, so I will improve it for the next release.

[eavestn]

@rochdev I would remove or modify this statement, then:

Each integration can be configured individually.

That leads the reader to believe this is something over which we have control (at least due to where it appears in the doc.s).

Thank you for the quick response!

[rochdev]

@eavestn You have control over the configuration options, but not the tags.

Do you think changing the statement to something like this could work?

Each integration has its own options and can be configured individually. There is also a list of tags that get added automatically to the span created by the integration.

[eavestn]

@rochdev I would suggest something similar:

Each integration has its own list of default tags. These tags get automatically added to the span created by the integration. Every integration is enabled by default; however, which integration is enabled can be individually configured.

Some flavor or combination of the two. Let me know if that above makes sense based on our conversation.

[rochdev]

@eavestn I think it makes sense. I would probably just change the last part to make it clearer that there are configuration options as well.

Something like:

however, each integration can also be enabled and configured individually.

[eavestn]

Looks good to me!

[rochdev]

Released in v0.2.1.