Add check prefix config

[AlexandreYang]

Add option to configure the prefix used for service checks.

This solves two issues:

• Some integration use prefix that doesn't necessarily correspond to the integration name.
  • Confluent Platform use confluent. as prefix. https:/DataDog/integrations-core/pull/5733/files#diff-9d75daf4238a279ff75c4a0c591b3d54R6
• When integration is a multi word e.g. my_integration, the _ is currently is stripped out. Which is usually not wanted.
  • example of issue [HOLD] Fix service check name integrations-core#5999

[olivielpeau]

This change makes sense overall 👍 Made a few suggestions inline

[olivielpeau]

Let's add an explanation here about what this formatting does, and why, see explanation here: 0428c41

This was, in hindsight, a poor solution to the technical problem at the time. As a way to start the transition to not using this formatting logic anymore, maybe it'd make sense to send both the formatted service check name and the unformatted one when your new option check_prefix is not specified, what do you think?

[AlexandreYang]

Formats the service check prefix name to enable having versionned .yaml
configuration files for the same checks (ex. : activemq/activemq_58)
while keeping on sending the same metric prefix. All numbers,
underscores and some other characters are simply removed from the prefix
if they are present.

I'm still not sure to understand why there was a need to strip those characters based on this comment ☝️ in order to have versioning (I don't have much context on this versioning concept).

This was, in hindsight, a poor solution to the technical problem at the time. As a way to start the transition to not using this formatting logic anymore, maybe it'd make sense to send both the formatted service check name and the unformatted one when your new option check_prefix is not specified, what do you think?

Yes, make sense. So, if the check_name is foo_bar:

• If check_prefix = foo, we send 2 service checks foo.can_connect and foobar.can_connect
• If check_prefix is not set, we send 2 service checks foo_can.connect and foobar.can_connect
• We deprecate the current formatting: foobar.can_connect

But then we need a deprecation process for when we should remove the old behaviour ?

[olivielpeau]

I'm still not sure to understand why there was a need to strip those characters based on this comment ☝️ in order to have versioning (I don't have much context on this versioning concept).

at the time there were 2 JMXFetch integrations for activemq: one called activemq for older versions of activemq, the other called activemq_58 for v5.8+ of activemq, see https:/DataDog/dd-agent/tree/5.10.x/conf.d

And we still wanted both integrations to send the service check with the activemq prefix, hence this formatting function...

So, if the check_name is foo_bar:

• If check_prefix = foo, we send 2 service checks foo.can_connect and foobar.can_connect
• If check_prefix is not set, we send 2 service checks foo_can.connect and foobar.can_connect
• We deprecate the current formatting: foobar.can_connect

I agree overall. In the case of check_prefix = foo, it's up to you whether we still want to send foobar.can_connect (we should if you need that behavior for existing integrations where you'll start using check_prefix, otherwise we should only send foo.can_connect)

But then we need a deprecation process for when we should remove the old behaviour ?

Yes, unclear how we'll do that. But at least JMXFetch will already be sending the "right" service check name.

[AlexandreYang]

@olivielpeau Just made changes related to this. Let me know if it's ok.

[olivielpeau]

Looks great, thanks!