# kafka-mirror-connect

> Connect Kafka application to KafkaMirror. Built on top of KafkaJS.

Latest version **1.0.3** (published 2021-01-07) · ISC license · 0 weekly downloads

## Install

```sh
npm install kafka-mirror-connect
pnpm add kafka-mirror-connect
yarn add kafka-mirror-connect
bun add kafka-mirror-connect
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2021-01-07 |
| First published | 2021-01-06 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 8.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 52 |
| Author | Jonah Stewart |
| Maintainers | daebaari, joekinney, jonahlstewart |
| Keywords | ['kafka', 'kafkajs', 'apache, kafka', 'apache', 'kafka, monitoring', 'monitoring', 'kafka, alert', 'kafka, gui', 'gui', 'alert', 'bitcoin', 'cryptocurrency', 'crypto', 'codesmith', 'fintech', 'blockchain', 'javascript'] |

## Links

- npm: https://www.npmjs.com/package/kafka-mirror-connect
- Repository: https://github.com/oslabs-beta/KafkaMirror
- Homepage: https://github.com/oslabs-beta/KafkaMirror#readme
- Issues: https://github.com/oslabs-beta/KafkaMirror/issues
- npm.io page: https://npm.io/package/kafka-mirror-connect

## Dependencies (2)

- [kafkajs](https://npm.io/package/kafkajs.md) ^1.15.0
- [winston](https://npm.io/package/winston.md) ^3.3.3

## Alternatives

- [update-check](https://npm.io/package/update-check.md) — 4.0M weekly downloads
- [react-native-onesignal](https://npm.io/package/react-native-onesignal.md) — 134.5K weekly downloads
- [react-redux-toastr](https://npm.io/package/react-redux-toastr.md) — 33.7K weekly downloads
- [@nocobase/plugin-notification-manager](https://npm.io/package/@nocobase/plugin-notification-manager.md) — 2.0K weekly downloads
- [react-simple-toasts](https://npm.io/package/react-simple-toasts.md) — 1.9K weekly downloads

## Recent versions

- 1.0.3 (latest) — 2021-01-07
- 1.0.2 — 2021-01-06
- 1.0.1 — 2021-01-06

## README

# KafkaMirror

Kafka monitoring tool

## Table of Contents

#### Overview

#### Demo

#### Quick Start

#### Viewing your metrics

#### Open-Source Kafka simulator tool

## Overview

- Monitor your Kafka application in real-time
- Track throughput, events per second
- Easily integrate KafkaMirror to your existing application
- Compatible with Kafka applications utilizing KafkaJS

KafkaMirror allows for easy, highly accurate monitoring of your kafka cluster in real-time. By directly accessing the log data for your kafka cluster, KafkaMirror delivers precise, reliable feedback which can be used to improve system health and identify irregularities.

## Demo

![kafka-mirror-events](./assets/events.gif 'KafkaMirror Event Metrics')
![kafka-mirror-throughput](./assets/throughput.gif 'KafkaMirror Throughput Metrics')<br>

## Quick Start

A few simple steps to initialize KafkaMirror:

1. `npm install kafka-mirror-connect`
2. In the file where you initialize your KafkaJS to connect with your Kafka Cluster, require in kafka-mirror connect.<br>

```js
const KafkaMirror = require('kafka-mirror-connect');
```

3. Replace "new Kafka" with a call to KafkaMirror. <br>

```js
const kafka = KafkaMirror({
  clientId,
  brokers: ['localhost:9092'],
});
```

<br>

## Viewing your metrics

The KafkaMirror GUI can be used to view your metrics.

1. Clone this repo (https://github.com/oslabs-beta/KafkaMirror.git)
2. cd into KafkaMirror
3. Start the application with npm start
4. Navigate to localhost:3000
5. Within the GUI, navigate to the setting page and enter the location (e.g. port 9092) of your Kafka cluster.

## Open source Kafka simulator

- https://github.com/oslabs-beta/kafka-simulator
  - preconfigured to work with KafkaMirror

The KafkaMirror GUI can be used to view your metrics.

## Authors

KafkaMirror Engineers:<br>
[Joe Kinney](https://github.com/joekinney-png)<br>
[Jonah Stewart](https://github.com/jonahlstewart)<br>
[Keon Kim](https://github.com/Keon-Kim-0)<br>
[Mark Miller](https://github.com/markmanuelmiller)<br>
[Tobi-wan Rodriguez](https://github.com/rtobiwan)<br>

---
_Source: https://npm.io/package/kafka-mirror-connect · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._