Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Indexer service #689

Merged
merged 6 commits into from
Aug 30, 2023
Merged

Indexer service #689

merged 6 commits into from
Aug 30, 2023

Conversation

miiu96
Copy link
Contributor

@miiu96 miiu96 commented Aug 29, 2023

Description of the pull request (what is new / what has changed)

Documentation how to use the elasticindexer service

Did you test the changes locally ?

  • yes
  • no

Which category (categories) does this pull request belong to?

  • document new feature
  • update documentation that is not relevant anymore
  • add examples or more information about a component
  • fix grammar issues
  • other

### Option 2

:::warning
this Option will be removed on the release `rc/v1.7.0`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we are not really sure about this now, maybe state this as:

we plan to remove this option in the release `rc/v1.7.0`

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changed


In the observer node's configuration directory, `external.toml` config file can be configured
to enable host driver config. The config file can be found
[here](https://github.com/multiversx/mx-chain-go/blob/master/cmd/node/config/external.toml).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changed the link


## Overview

A MultiversX observer node can send messages over `WebSocket` to an elastic indexer service, which will process and index the data in an Elasticsearch database.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add a statement here that this feature will work starting from rc/v1.6.0 version of the node?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added

@mariusmihaic mariusmihaic self-requested a review August 29, 2023 13:57
Copy link
Contributor

@mariusmihaic mariusmihaic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


The supported config variables are as follows:

- `Enabled`: signals whether a driver should be attached when launching the node.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should remove these lines, since you already reference the config and added it below with extra comments (otherwise we are just duplicating the same info). OR merge the relevant info from both into a single one

Also, we should change MarshallerType description in https://github.com/multiversx/mx-chain-go/blob/rc/v1.6.0/cmd/node/config/external.toml, since we already support gogo proto messages

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

removed

In the `elasticindexer` configuration directory (`cmd/elasticindexer/config`), there is the `prefs.toml`
file that can be used to configure the service.

The supported config variables for web-socket section are:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment as above

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

removed

acknowledge-timeout-in-seconds = 50
```

The supported config variables for the `elastic-cluster` section:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

removed

iulianpascalau
iulianpascalau previously approved these changes Aug 30, 2023
@miiu96 miiu96 self-assigned this Aug 30, 2023
@iulianpascalau iulianpascalau merged commit 12da840 into development Aug 30, 2023
1 check passed
@iulianpascalau iulianpascalau deleted the indexer-service branch August 30, 2023 11:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants