Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
d-t-w committed May 7, 2024
1 parent 657383f commit aaef34c
Show file tree
Hide file tree
Showing 10 changed files with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,22 +8,21 @@ This repository contains the Kpow Streams Agent.
Use this agent to integrate your Kafka Streams applications with Kpow and unlock the following features:

* See summaries of Kafka Streams activity for your Kafka cluster(s).
* Monitor Kafka Streams metrics (e.g Streams State, Stream-Thread, State Store, RocksDB, etc).
* Visualise Kafka Streams topologies in the Kpow Workflows UI.
* Monitor Kafka Streams metrics (e.g Stream-Thread, State Store, RocksDB, etc).
* Aggregate and Expose Kafka Streams metrics via Kpow [Prometheus Endpoints](https://docs.kpow.io/features/prometheus) (for alerting, etc).
* (Soon) View Kpow Insights of your Kafka Streams applications (outlier metrics, etc).

See the [Kpow Kafka Streams Feature Guide](https://docs.kpow.io/features/kafka-streams) for full documentation.
See the [Kpow Kafka Streams Feature Guide](https://docs.factorhouse.io/kpow-ee/features/kafka-streams/) for full documentation.

See the [Kpow Kafka Streams Spring Word Count Example](https://github.com/factorhouse/kpow-streams-spring-cloud-example) for an integration of Spring, Kafka, and Kpow.

---

![streams-ui](docs/streams.png)
![streams-ui](docs/kpow-streams.png)

---

![topology-ui](docs/topologies.png)
![topology-ui](docs/kpow-streams-topology.png)

# Prerequisites

Expand Down Expand Up @@ -195,9 +194,9 @@ You can verify `StreamsRegistry` is sending telemetry to your Kafka Cluster by u

* Select topic `__oprtr_snapshot_state`
* Choose `Transit / JSON` as the key deserializer
* Enter the following kJQ filter for the key: `.[0] == :streams`
* Enter the following kJQ filter: `.key[0] == :streams`

![Data Inspect](docs/data-inspect.png)
![Data Inspect](docs/kpow-data-inspect.png)

# Get Help

Expand Down
Binary file removed docs/data-inspect.png
Binary file not shown.
Binary file added docs/kpow-data-inspect.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/kpow-streams-topology.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/kpow-streams.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/screenshot.png
Binary file not shown.
Binary file removed docs/streams-ui.png
Binary file not shown.
Binary file removed docs/streams.png
Binary file not shown.
Binary file removed docs/topologies.png
Binary file not shown.
Binary file removed docs/topology-ui.png
Binary file not shown.

0 comments on commit aaef34c

Please sign in to comment.