{"_id":"kafkatrace","_rev":"68-808143e035232d92a6234808fff0ce3e","time":{"created":"2023-07-25T14:37:04.531Z","1.0.0":"2023-07-18T00:10:12.347Z","modified":"2023-09-13T17:17:36.849Z","1.0.1":"2023-07-18T00:55:50.878Z","1.0.2":"2023-07-18T01:04:04.171Z","1.0.3":"2023-07-18T04:37:25.073Z","1.0.4":"2023-07-20T14:50:27.846Z","1.0.6":"2023-07-20T15:15:24.174Z","1.0.7":"2023-07-20T15:17:52.519Z","1.0.8":"2023-07-20T15:20:34.337Z","1.0.9":"2023-07-20T19:05:31.279Z","1.0.10":"2023-07-20T19:37:38.844Z","1.0.11":"2023-07-20T19:44:54.694Z","1.0.12":"2023-07-20T19:48:29.173Z","1.0.13":"2023-07-20T20:14:22.897Z","1.0.14":"2023-07-20T23:50:05.790Z","1.0.15":"2023-07-20T23:56:40.876Z","1.0.16":"2023-07-21T16:40:02.535Z","1.0.17":"2023-07-21T18:28:43.789Z","1.0.18":"2023-07-21T18:29:45.398Z","1.0.19":"2023-07-21T18:30:19.327Z","1.0.20":"2023-07-21T18:33:20.432Z","1.0.21":"2023-07-21T18:34:50.179Z","1.0.22":"2023-07-21T18:35:49.412Z","1.0.23":"2023-07-21T18:38:32.620Z","1.0.24":"2023-07-21T18:40:52.683Z","1.0.25":"2023-07-21T18:42:33.124Z","1.0.26":"2023-07-21T18:43:53.256Z","1.0.27":"2023-07-21T18:44:46.438Z","1.0.28":"2023-07-21T18:45:56.739Z","1.0.29":"2023-07-21T18:46:32.333Z","1.0.30":"2023-07-21T18:47:09.345Z","1.0.31":"2023-07-21T18:49:05.589Z","1.0.32":"2023-07-21T18:51:28.916Z","1.0.33":"2023-07-21T19:07:33.978Z","1.0.34":"2023-07-21T19:10:31.136Z","1.0.35":"2023-07-21T19:14:21.051Z","1.0.36":"2023-07-21T19:15:32.016Z","1.0.37":"2023-07-21T19:16:18.218Z","1.0.38":"2023-07-21T19:20:18.418Z","1.0.39":"2023-07-21T19:24:39.130Z","1.0.40":"2023-07-21T19:26:12.848Z","1.0.41":"2023-07-21T19:42:22.701Z","1.0.42":"2023-07-21T20:28:46.108Z","1.0.43":"2023-07-21T20:31:05.585Z","1.0.44":"2023-07-21T20:34:08.413Z","1.0.45":"2023-07-21T20:38:12.891Z","1.0.46":"2023-07-21T21:05:50.911Z","1.0.47":"2023-07-21T21:10:10.439Z","1.0.48":"2023-07-21T21:18:55.117Z","1.0.49":"2023-07-21T21:30:37.874Z","1.0.50":"2023-07-21T21:36:33.732Z","1.0.51":"2023-07-21T23:29:35.198Z","1.0.52":"2023-07-21T23:32:22.568Z","1.0.53":"2023-07-22T18:18:33.548Z","1.0.54":"2023-07-22T18:38:54.735Z","1.0.55":"2023-07-22T18:45:39.216Z","1.0.56":"2023-07-22T18:47:13.356Z","1.0.57":"2023-07-22T18:50:20.974Z","1.0.58":"2023-07-22T18:58:26.954Z","1.0.59":"2023-07-22T19:01:20.476Z","1.0.60":"2023-07-22T19:34:11.419Z","1.0.61":"2023-07-23T21:44:15.754Z","1.0.63":"2023-07-23T23:17:17.606Z","1.0.64":"2023-07-24T00:24:55.148Z","1.0.65":"2023-07-24T00:26:13.831Z","1.0.66":"2023-07-24T01:25:35.585Z","1.1.0":"2023-07-25T14:37:04.733Z","1.1.1":"2023-07-27T21:01:46.160Z","1.1.2":"2023-09-13T17:17:36.702Z"},"name":"kafkatrace","dist-tags":{"latest":"1.1.2"},"versions":{"1.1.0":{"name":"kafkatrace","version":"1.1.0","description":"Trace Apache Kafka systems in Javascript","main":"dist/index.js","types":"dist/index.d.ts","scripts":{"test":"jest --config jestconfig.json","build":"tsc"},"repository":{"type":"git","url":"git+https://github.com/oslabs-beta/kafkatrace-npm-package.git"},"keywords":["Kafka","KafkaJS","OpenTelemetry","Tracing","Traces","Metrics","Logs","Jaeger","Zipkin","Prometheus"],"author":{"name":"KafkaTrace","email":"kafkatrace@gmail.com"},"contributors":[{"name":"Wai San Gu","url":"https://github.com/waisangu"},{"name":"Navdeep Simmak","url":"https://github.com/NaviSimmak"},{"name":"Alston Nguyen","url":"https://github.com/alstonnguyen"},{"name":"Felix Chen","url":"https://github.com/flexzchen"}],"license":"MIT","bugs":{"url":"https://github.com/oslabs-beta/kafkatrace-npm-package/issues"},"homepage":"https://github.com/oslabs-beta/kafkatrace-npm-package#readme","dependencies":{"@opentelemetry/exporter-metrics-otlp-proto":"^0.41.0","@opentelemetry/instrumentation-express":"^0.33.0","@opentelemetry/instrumentation-http":"^0.41.0","@opentelemetry/sdk-node":"^0.41.0","opentelemetry-instrumentation-kafkajs":"^0.35.0","docker-compose":"^0.24.1","kafkajs":"^2.2.4","path":"^0.12.7"},"devDependencies":{"@types/jest":"^29.5.3","jest":"^29.6.1","ts-jest":"^29.1.1","typescript":"^5.1.6"},"_id":"kafkatrace@1.1.0","gitHead":"d59b0c1fcb9c9d892d204377856d30dc4dcd98bf","_nodeVersion":"18.16.0","_npmVersion":"9.8.0","dist":{"integrity":"sha512-l4dNghj9Ab8xriHxisCrlQTRoR+DCE5rn9G1dh6dZFcMV94er5MRqaFfrntSSXKNfoXvFu525Mt/IHdA2h7aMg==","shasum":"d24b35bfeab9e4f13acf2daa37a5db2a86b3a995","tarball":"https://registry.npmjs.org/kafkatrace/-/kafkatrace-1.1.0.tgz","fileCount":18,"unpackedSize":13570,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIAgbAp9WrtRkUJW3xIvg1qzmksaWU96YNiQi1tbQaKg7AiB//kF3/YBD7TFkKhDYO457H6gLhnduS2RvWv51Lrqf8g=="}]},"_npmUser":{"name":"kafkatrace-npm","email":"kafkatrace@gmail.com"},"directories":{},"maintainers":[{"name":"kafkatrace-npm","email":"kafkatrace@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/kafkatrace_1.1.0_1690295824533_0.18471424017896343"},"_hasShrinkwrap":false},"1.1.1":{"name":"kafkatrace","version":"1.1.1","description":"Trace Apache Kafka systems in Javascript","main":"dist/index.js","types":"dist/index.d.ts","scripts":{"test":"jest --config jestconfig.json","build":"tsc"},"repository":{"type":"git","url":"git+https://github.com/oslabs-beta/kafkatrace-npm-package.git"},"keywords":["Kafka","KafkaJS","OpenTelemetry","Tracing","Traces","Metrics","Logs","Jaeger","Zipkin","Prometheus"],"author":{"name":"KafkaTrace","email":"kafkatrace@gmail.com"},"contributors":[{"name":"Wai San Gu","url":"https://github.com/waisangu"},{"name":"Navdeep Simmak","url":"https://github.com/NaviSimmak"},{"name":"Alston Nguyen","url":"https://github.com/alstonnguyen"},{"name":"Felix Chen","url":"https://github.com/flexzchen"}],"license":"MIT","bugs":{"url":"https://github.com/oslabs-beta/kafkatrace-npm-package/issues"},"homepage":"https://kafkatrace.com","dependencies":{"@opentelemetry/exporter-metrics-otlp-proto":"^0.41.0","@opentelemetry/instrumentation-express":"^0.33.0","@opentelemetry/instrumentation-http":"^0.41.0","@opentelemetry/sdk-node":"^0.41.0","opentelemetry-instrumentation-kafkajs":"^0.35.0","docker-compose":"^0.24.1","kafkajs":"^2.2.4","path":"^0.12.7"},"devDependencies":{"@types/jest":"^29.5.3","jest":"^29.6.1","ts-jest":"^29.1.1","typescript":"^5.1.6"},"_id":"kafkatrace@1.1.1","gitHead":"01b8ed0f5edbc8a926745f7b340925b27f84cb72","_nodeVersion":"18.16.0","_npmVersion":"9.8.0","dist":{"integrity":"sha512-/2/IuOY+PWr5f6sSM4gFXQDyFhsUnxcDKRWD0Zp+yzdR6Zijbqyoqq+aE7BRCv/Yyx5WvXwcoGFHsIIrbjWozQ==","shasum":"0202d1e90b0f1de7208dacc576b6a75bb69eb84e","tarball":"https://registry.npmjs.org/kafkatrace/-/kafkatrace-1.1.1.tgz","fileCount":18,"unpackedSize":20771,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCICQ2wN3OP91THJ5EjY7W/Df+hZxTZV+CZHG8brQ6lM1XAiBXSq30sS0G2pzY81By/0G9LeM54QIfL7vdTAV7Kmaf/w=="}]},"_npmUser":{"name":"kafkatrace-npm","email":"kafkatrace@gmail.com"},"directories":{},"maintainers":[{"name":"kafkatrace-npm","email":"kafkatrace@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/kafkatrace_1.1.1_1690491705998_0.6216140210039027"},"_hasShrinkwrap":false},"1.1.2":{"name":"kafkatrace","version":"1.1.2","description":"Trace Apache Kafka systems in Javascript","main":"dist/index.js","types":"dist/index.d.ts","scripts":{"test":"jest --config jestconfig.json","build":"tsc"},"repository":{"type":"git","url":"git+https://github.com/oslabs-beta/kafkatrace-npm-package.git"},"keywords":["Kafka","KafkaJS","OpenTelemetry","Tracing","Traces","Metrics","Logs","Jaeger","Zipkin","Prometheus"],"author":{"name":"KafkaTrace","email":"kafkatrace@gmail.com"},"contributors":[{"name":"Wai San Gu","url":"https://github.com/waisangu"},{"name":"Navdeep Simmak","url":"https://github.com/NaviSimmak"},{"name":"Alston Nguyen","url":"https://github.com/alstonnguyen"},{"name":"Felix Chen","url":"https://github.com/flexzchen"}],"license":"MIT","bugs":{"url":"https://github.com/oslabs-beta/kafkatrace-npm-package/issues"},"homepage":"https://kafkatrace.com","dependencies":{"@opentelemetry/exporter-metrics-otlp-proto":"^0.41.0","@opentelemetry/instrumentation-express":"^0.33.0","@opentelemetry/instrumentation-http":"^0.41.0","@opentelemetry/sdk-node":"^0.41.0","opentelemetry-instrumentation-kafkajs":"^0.35.0","docker-compose":"^0.24.1","kafkajs":"^2.2.4","path":"^0.12.7"},"devDependencies":{"@types/jest":"^29.5.3","jest":"^29.6.1","ts-jest":"^29.1.1","typescript":"^5.1.6"},"_id":"kafkatrace@1.1.2","gitHead":"e9b9b6789c00b04d7a9f00c671709d35489055e7","_nodeVersion":"18.16.0","_npmVersion":"9.8.0","dist":{"integrity":"sha512-YRV3z/KoonNMGSGNvKr9DwUlNxU/G5l3tetZeXZhtpxkgHSRiXnOj+qiT0U/Zt9DDwR9xXSLSJMgwwIp3jZtCA==","shasum":"22a75e22b6118f9e787c671e9be2cea7b98e73e7","tarball":"https://registry.npmjs.org/kafkatrace/-/kafkatrace-1.1.2.tgz","fileCount":18,"unpackedSize":20321,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIHZGhWrAQprIXpRRvoyfEyCps2Hu4BMMx9jYdnBMhUfkAiB3xYnXkCauYbU990jDH4pZOzp1Fuw/DBa3hkJGlxXlaQ=="}]},"_npmUser":{"name":"kafkatrace-npm","email":"kafkatrace@gmail.com"},"directories":{},"maintainers":[{"name":"kafkatrace-npm","email":"kafkatrace@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/kafkatrace_1.1.2_1694625456506_0.16757516304725528"},"_hasShrinkwrap":false}},"maintainers":[{"name":"kafkatrace-npm","email":"kafkatrace@gmail.com"}],"description":"Trace Apache Kafka systems in Javascript","homepage":"https://kafkatrace.com","keywords":["Kafka","KafkaJS","OpenTelemetry","Tracing","Traces","Metrics","Logs","Jaeger","Zipkin","Prometheus"],"repository":{"type":"git","url":"git+https://github.com/oslabs-beta/kafkatrace-npm-package.git"},"contributors":[{"name":"Wai San Gu","url":"https://github.com/waisangu"},{"name":"Navdeep Simmak","url":"https://github.com/NaviSimmak"},{"name":"Alston Nguyen","url":"https://github.com/alstonnguyen"},{"name":"Felix Chen","url":"https://github.com/flexzchen"}],"author":{"name":"KafkaTrace","email":"kafkatrace@gmail.com"},"bugs":{"url":"https://github.com/oslabs-beta/kafkatrace-npm-package/issues"},"license":"MIT","readme":"# KafkaTrace\n<div align=\"center\">\n<img width=\"364\" alt=\"image\" src=\"https://github.com/oslabs-beta/KafkaTrace/blob/dev/public/assets/LogoWithText-Blue.jpg?raw=true\">\n</div>\n\n## Table of Contents\n- [About Kafka Trace](#about-kafka-trace)\n- [Tech Stacks](#tech-stacks)\n- [Features](#features)\n- [User Guide](#user-guide)\n- [Authors](#authors)\n- [License](#license)\n\n## About KafkaTrace\nBased on OpenTelemetry's standards, KafkaTrace streamlines the process of visualizing your Apache Kafka Clients by packaging together the necessary instrumentation files with popular open source monitoring UIs (Jaeger, Zipkin, and Prometheus). This documentation describes how to implement KafkaTrace.\n\nFor more information, [visit our website](#).\n\n## Tech Stacks\n<div align=\"center\" width=\"100%\">\n            \n[![Typescript][TS.js]][TS-url][![JavaScript][JavaScript]][JavaScript-url][![React][React.js]][React-url][![Prometheus][Prometheus]][Prometheus-url][![Zipkin][Zipkin]][Zipkin-url][![Jaeger][Jaeger]][Jaeger-url][![OpenTelemetry][OpenTelemetry]][OpenTelemetry-url][![Jest][Jest]][Jest-url][![][Git]][Git-url][![Tailwind][Tailwind]][Tailwind-url][![DaisyUI][DaisyUI]][DaisyUI-url][![NextJS][NextJs]](NextJS-url)[![NextAuth][NextAuth]][NextAuth-url][![KafkaJS][KafkaJS]][KafkaJS-url][![Docker][Docker]][Docker-url][![AWS][AWS]][AWS-url]\n\n</div>\n\n## Features\n- Intuitive all-in-one documentation to implement distributive tracing for Kafka.\n- Authentication for Google and GitHub OAuth.\n\n## User Guide\n#### Prerequisites:\nYou must have Docker Desktop installed and running!\n<br></br>\t\n\n**IMPORTANT REMINDER**: Make sure the Kafka Cluster you want to trace has a working producer and consumer client.\n\n- **STEP 1**: Install npm package\n    ```bash\n    npm install kafkatrace\n    ```\n- **STEP 2**: Build and run the preconfigured containers\n    ```typescript\n    import { composer } from 'kafkatrace';\n    composer();\n    ```\n- **STEP 3**: Add to each service file and replace [Service Name] as required\n    ```typescript\n    import { tracer } from 'kafkatrace';\n    tracer('[Service Name]');\n    ```\n- **STEP 4**: Navigate to localhost port: 16686 for Jaeger, 9411 for Zipkin, 9090 for Prometheus or simply login to the website\n\n![demo-vid](https://github.com/oslabs-beta/kafkatrace-npm-package/assets/101201710/393720f4-597f-4439-87de-8b8fd60e655a)\n\n\n## Authors\n| Developed By |                                                                     Github                                                                      |                                                                   LinkedIn                                                                    |\n| :----------: | :---------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------: |\n|  Felix Chen  |    [![Github](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)](https://github.com/flexzchen)    | [![LinkedIn](https://img.shields.io/badge/LinkedIn-%230077B5.svg?logo=linkedin&logoColor=white)](https://www.linkedin.com/in/felixzchen/) |\n| Navdeep Simmack | [![Github](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)](https://github.com/NaviSimmak) |  [![LinkedIn](https://img.shields.io/badge/LinkedIn-%230077B5.svg?logo=linkedin&logoColor=white)](https://www.linkedin.com/in/Navdeep-Simmak)  |\n|  Wai San Gu  |  [![Github](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)](https://github.com/waisangu)   | [![LinkedIn](https://img.shields.io/badge/LinkedIn-%230077B5.svg?logo=linkedin&logoColor=white)](https://www.linkedin.com/in/waisangu/) |\n| Alston Nguyen  |  [![Github](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)](https://github.com/alstonnguyen)   |  [![LinkedIn](https://img.shields.io/badge/LinkedIn-%230077B5.svg?logo=linkedin&logoColor=white)](https://www.linkedin.com/in/alston-s-nguyen/)   |\n\n\n## License\nDistributed under MIT License. See `LICENSE.txt` for more information.\n\n[React.js]: https://img.shields.io/badge/react-%2320232a.svg?style=for-the-badge&logo=react&logoColor=%2361DAFB\n[React-url]: https://reactjs.org/\n[TS.js]: https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white\n[TS-url]: https://www.typescriptlang.org/\n[Prometheus]: https://img.shields.io/badge/Prometheus-E6522C?style=for-the-badge&logo=Prometheus&logoColor=white\n[Prometheus-url]: https://prometheus.io/\n[Zipkin]: https://img.shields.io/badge/zipkin-%23593d88.svg?style=for-the-badge&logo=zipkin&logoColor=white\n[Zipkin-url]:https://zipkin.io/\n[Jaeger]:https://img.shields.io/badge/Jaeger-%23F46800.svg?style=for-the-badge&logo=Jaeger&logoColor=white\n[Jaeger-url]:https://www.jaegertracing.io/\n[OpenTelemetry]:https://img.shields.io/badge/OpenTelemetry-3d348b?style=for-the-badge&logo=opentelemetry&logoColor=white\n[OpenTelemetry-url]:https://opentelemetry.io/\n[JavaScript]: https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge&logo=javascript&logoColor=%23F7DF1E\n[JavaScript-url]: https://www.javascript.com/\n[Jest]: https://img.shields.io/badge/-jest-%23C21325?style=for-the-badge&logo=jest&logoColor=white\n[Jest-url]: https://jestjs.io/\n[Docker]: https://img.shields.io/badge/docker-%230db7ed.svg?style=for-the-badge&logo=docker&logoColor=white\n[Docker-url]: https://www.docker.com/\n[Git]: https://img.shields.io/badge/git-%23F05033.svg?style=for-the-badge&logo=git&logoColor=white\n[Git-url]: https://git-scm.com/\n[Tailwind]: https://img.shields.io/badge/Tailwind-%231DA1F2.svg?style=for-the-badge&logo=tailwind-css&logoColor=white\n[Tailwind-url]: https://tailwindcss.com/\n[DaisyUI]:https://img.shields.io/badge/DaisyUI-%23593d88.svg?style=for-the-badge&logo=DaisyUI&logoColor=white\n[DaisyUI-url]:https://daisyui.com/\n[NextJS]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white\n[NextJS-url]: https://nextjs.org/\n[Prisma]: https://img.shields.io/badge/Prisma-%233b3e44?style=for-the-badge&logo=prisma&logoColor=white\n[Prisma-url]: https://www.prisma.io/\n[NextAuth]: https://img.shields.io/badge/NextAuth-%23F05033.svg?style=for-the-badge&logo=nextdotjs&logoColor=white\n[NextAuth-url]: https://next-auth.js.org/\n[KafkaJS]: https://img.shields.io/badge/KafkaJS-%2316AB39.svg?style=for-the-badge&logo=kafkajs&logoColor=white\n[KafkaJS-url]: https://kafka.js.org/\n[AWS]: https://img.shields.io/badge/AWS-%231E73BE.svg?style=for-the-badge&logo=amazon-aws&logoColor=white:\n[AWS-url]: https://aws.amazon.com/\n","readmeFilename":"README.md"}