antonmry/kafka-showbacks-demo

kafka-showback-demo

KafkaShowbacksDemo split the cost supplied by the Cloud provider by teams/applications. To be aware about the different costs that we have in our Kafka environments can help to detect problems related with incorrect configurations.

KafkaShowbacksDemo works with Kafka Confluent environment due that the Confluent Cloud provide a complete set of API to get the information that we need to calculate the costs. The costs calculated are sent to NewRelicDB.

Service account format

As in the introduction has been mentioned one of the goals of this KafkaShowBackDemo service is assign the different costs to the different teams. To do it, we need to identify the team and application that is assigned to each service account. We have solved this problem assigning a description with a determinate format, and thanks to this format we can have this match between the service account and the team/application. So is mandatory that the description of service account has the following format:

"Service account for the {CLUSTER},{TEAM},{APPLICATION} application"

Handle duplicate data

KafkaShowBacks demo service not handle the duplicate records when generate the data to NewRelic event, so in case that you have generated duplicate or incorrect data you have to remove manually. To do it you can use Drop data using NerdGraph.

Run locally

Environment variables

To run the KafkaShowBacksService is mandatory se this environment variables of update the configuration in server.yml.

• Confluent environment:

  • CONFLUENT_CLUSTER_LIST: ClusterId list with format [x,x,x]. This parameter is mandatory and has to include all the Confluent clustersId that you want to obtain the cost.
  • Confluent authentication:
    • CONFLUENT_API_KEY
    • CONFLUENT_API_SECRET
  • Confluent APIs:
    • CONFLUENT_BILLING_URL
    • CONFLUENT_SERVICE_ACCOUNT_URL
    • CONFLUENT_TELEMETRY_URL

• NewRelic:

  • NR_ACCOUNT_ID
  • NR_CUSTOM_EVENT_API_URL
  • NR_LICENSE_API_KEY

Days to execute

By default, the KafkaShowBacksDemo service calculates the cost for the day before of the execution. You could launch the service to get the cost for more days changing the daysToExecute parameter in server.yml calculates more than 1 day before. Take into account that Confluent API has a limitation of 7 days before, so it's not possible to obtain the cost for more than 7 days.

Build Confluent environment with terraform

In template folder you can find a set of template to build a Confluent environment with terraform, in the case that you need it:

• Create dedicated cluster with terraform.
• Create services account and Key API with
• Create topics
• Example of service account configuration file
• Script to generate data with different configurations

Support links

• Confluent:
  • Kafka command cli
  • Kafka tools
  • Create a resource API Key
  • Service accounts
• Confluent Terraform provider
• Drop data using NerdGraph