Skip to content

Commit

Permalink
docs(guide): adjusted kafka guide
Browse files Browse the repository at this point in the history
  • Loading branch information
paulobressan committed Aug 11, 2023
1 parent 8c2416c commit 0bda96d
Showing 1 changed file with 6 additions and 23 deletions.
29 changes: 6 additions & 23 deletions docs/pages/v2/guides/cardano_2_kafka.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ This guide shows how to leverage _Oura_ to stream data from a Cardano node into
Find [more info](https://en.wikipedia.org/wiki/Apache_Kafka) about _Kafka_ in wikipedia or visit _Kafka's_ official [website](https://kafka.apache.org/)


## Prerequisites

This examples assumes the following prerequisites:
Expand All @@ -25,8 +24,7 @@ This examples assumes the following prerequisites:
```toml
[source]
type = "N2C"
address = ["Unix", "/opt/cardano/cnode/sockets/node0.socket"]
magic = "testnet"
socket_path = "/opt/cardano/cnode/sockets/node0.socket"

[sink]
type = "Kafka"
Expand All @@ -37,13 +35,12 @@ topic = "cardano-events"
Some comments regarding the above configuration:

- the `[source]` section indicates _Oura_ from where to pull chain data.
- the `N2C` source type value tells _Oura_ to get the data from a Cardano node using Node-to-Client mini-protocols (chain-sync instantiated to full blocks).
- the `address` field indicates that we should connect via `Unix` socket at the specified path. This value should match the location of your local node socket path.
- the `magic` field indicates that our node is running in the `testnet` network. Change this value to `mainnet` if appropriate.
- the `N2C` source type value tells _Oura_ to get the data from a Cardano node using Node-to-Client mini-protocols (chain-sync instantiated to full blocks).
- the `socket_path` field indicates that we should connect via `Unix` socket at the specified path. This value should match the location of your local node socket path.
- the `[sink]` section tells _Oura_ where to send the information it gathered.
- the `Kafka` sink type value indicates that _Oura_ should use a _Kafka_ producer client as the output
- the `brokers` field indicates the location of the _Kafka_ brokers within the network. Several hostname:port pairs can be added to the array for a "cluster" scenario.
- the `topic` fields indicates which _Kafka_ topic to used for the outbound messages.
- the `Kafka` sink type value indicates that _Oura_ should use a _Kafka_ producer client as the output
- the `brokers` field indicates the location of the _Kafka_ brokers within the network. Several hostname:port pairs can be added to the array for a "cluster" scenario.
- the `topic` fields indicates which _Kafka_ topic to used for the outbound messages.

### 2. Run _Oura_ in `daemon` mode

Expand All @@ -52,17 +49,3 @@ Run the following command from your terminal to start the daemon process:
```sh
RUST_LOG=info oura daemon --config cardano2kafka.toml
```

You should see an output similar to the following:

```
[2021-12-13T22:16:43Z INFO oura::sources::n2n::setup] handshake output: Accepted(7, VersionData { network_magic: 764824073, initiator_and_responder_diffusion_mode: false })
[2021-12-13T22:16:43Z INFO oura::sources::n2n::setup] chain point query output: Some(Tip(Point(47867448, "f170baa5702c91b23580291c3a184195df7c77d3e1a03b3d6424793aacc850d6"), 6624258))
[2021-12-13T22:16:43Z INFO oura::sources::n2n::setup] node tip: Point(47867448,"f170baa5702c91b23580291c3a184195df7c77d3e1a03b3d6424793aacc850d6")
[2021-12-13T22:16:44Z INFO oura::sources::n2n] rolling block to point Point(47867448, "f170baa5702c91b23580291c3a184195df7c77d3e1a03b3d6424793aacc850d6")
[2021-12-13T22:16:52Z INFO oura::sources::n2n] requesting block fetch for point Some(Point(47867448, "f170baa5702c91b23580291c3a184195df7c77d3e1a03b3d6424793aacc850d6"))
[2021-12-13T22:17:15Z INFO oura::sources::n2n] requesting block fetch for point Some(Point(47867448, "f170baa5702c91b23580291c3a184195df7c77d3e1a03b3d6424793aacc850d6"))
[2021-12-13T22:17:20Z INFO oura::sources::n2n] requesting block fetch for point Some(Point(47867448, "f170baa5702c91b23580291c3a184195df7c77d3e1a03b3d6424793aacc850d6"))
```


0 comments on commit 0bda96d

Please sign in to comment.