{"id":21282389,"url":"https://github.com/vadeg/kafkawizard","last_synced_at":"2025-03-15T14:23:34.936Z","repository":{"id":57723810,"uuid":"250860284","full_name":"vadeg/kafkawizard","owner":"vadeg","description":null,"archived":false,"fork":false,"pushed_at":"2020-06-13T12:35:45.000Z","size":75,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-22T04:31:25.923Z","etag":null,"topics":["dropwizard","kafka","metrics","monitoring"],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vadeg.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-03-28T17:58:49.000Z","updated_at":"2021-10-25T19:43:30.000Z","dependencies_parsed_at":"2022-08-25T13:00:28.834Z","dependency_job_id":null,"html_url":"https://github.com/vadeg/kafkawizard","commit_stats":null,"previous_names":["vadeg/kafkawizard-metrics"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vadeg%2Fkafkawizard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vadeg%2Fkafkawizard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vadeg%2Fkafkawizard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vadeg%2Fkafkawizard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vadeg","download_url":"https://codeload.github.com/vadeg/kafkawizard/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243740855,"owners_count":20340361,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dropwizard","kafka","metrics","monitoring"],"created_at":"2024-11-21T10:54:34.032Z","updated_at":"2025-03-15T14:23:34.903Z","avatar_url":"https://github.com/vadeg.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Build \u0026 Test](https://github.com/vadeg/kafkawizard-metrics/workflows/Build%20\u0026%20Test/badge.svg?branch=master)\n![Maven Central](https://img.shields.io/maven-central/v/com.github.vadeg/kafkawizard)\n\n# Kafka clients metrics collector\n\nA tool which collects producer and consumer Kafka metrics and expose them using [Dropwizard](https://metrics.dropwizard.io/4.1.2/index.html) metric library.\n\n# Features\n\n* Expose Kafka consumer and producer metrics using Dropwizard\n* Supports default and custom `MetricRegistry`\n* Group metrics by `client.id` property by default\n\n# Installation\n\nCheck latest version in [Maven Central](https://search.maven.org/search?q=g:com.github.vadeg%20AND%20a:kafkawizard). \n\n## Maven\n```xml\n\u003cdependency\u003e\n  \u003cgroupId\u003ecom.github.vadeg\u003c/groupId\u003e\n  \u003cartifactId\u003ekafkawizard\u003c/artifactId\u003e\n  \u003cversion\u003e0.0.1\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n## Gradle \n### Groovy DSL\n```\nimplementation 'com.github.vadeg:kafkawizard:0.0.1'\n```\n\n### Kotlin DSL\n```\nimplementation(\"com.github.vadeg:kafkawizard:0.0.1\")\n```\n\n## Scala\n```sbt\nlibraryDependencies += \"com.github.vadeg\" % \"kafkawizard\" % \"0.0.1\"\n```\n\n# Usage\n\nAdd the following property to Kafka producer or consumer configuration:\n```java\nprops.put(ProducerConfig.METRIC_REPORTER_CLASSES_CONFIG, KafkaWizardConfig.REPORTER_NAME);\n```\n\n## Example\n```java\n// Configure MetricRegistry and reporter\nMetricRegistry metricRegistry = SharedMetricRegistries.setDefault(\"default\");\nConsoleReporter reporter = ConsoleReporter.forRegistry(metricRegistry).build();\nreporter.start(10, TimeUnit.SECONDS);\n\n// Configure Kafka producer\nProperties props = new Properties();\nprops.put(\"bootstrap.servers\", \"localhost:9092\");\nprops.put(\"key.serializer\", \"org.apache.kafka.common.serialization.StringSerializer\");\nprops.put(\"value.serializer\", \"org.apache.kafka.common.serialization.StringSerializer\");\nprops.put(ProducerConfig.METRIC_REPORTER_CLASSES_CONFIG, KafkaWizardConfig.REPORTER_NAME);\n\nProducer producer = new KafkaProducer\u003c\u003e(props);\n// some producer logic\n```\n\n### Output\n```shell script\nKafkaWizardConfig values:\n\tkafkawizard.metrics.registry.name = null\n\tkafkawizard.metrics.prefix = kafka\n\nNo metric registry name provided. Fallback to default\nKafka version: 2.3.0\n[Producer clientId=producer-1] Cluster ID: Y4ZFWccXRG6J199AxxG2sQ\n-- Gauges ----------------------------------------------------------------------\nkafka.app-info.producer-1.commit-id\n             value = fc1aaa116b661c8a\nkafka.app-info.producer-1.start-time-ms\n             value = 1586519482483\nkafka.app-info.producer-1.version\n             value = 2.3.0\nkafka.kafka-metrics-count.producer-1.count\n             value = 102.0\n```\n\n# Configuration\n| Key | Description |\n|-----| ------------|\n| `kafkawizard.metrics.registry.name` | Name of the registry. If not specified the reported will try to get a default from `SharedMetricRegistries` |\n| `kafkawizard.metrics.prefix` | Metrics prefix. Default prefix is `kafka` |\n  ","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvadeg%2Fkafkawizard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvadeg%2Fkafkawizard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvadeg%2Fkafkawizard/lists"}