Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/allancapistrano/tangle-hornet-monitoring
Faz a leitura e monitora o tempo de resposta de consultas a transações na Tangle Hornet.
https://github.com/allancapistrano/tangle-hornet-monitoring
monitoring tangle tangle-hornet
Last synced: 23 days ago
JSON representation
Faz a leitura e monitora o tempo de resposta de consultas a transações na Tangle Hornet.
- Host: GitHub
- URL: https://github.com/allancapistrano/tangle-hornet-monitoring
- Owner: AllanCapistrano
- License: gpl-3.0
- Created: 2023-08-12T16:38:07.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-16T00:58:37.000Z (5 months ago)
- Last Synced: 2024-06-16T23:39:23.631Z (5 months ago)
- Topics: monitoring, tangle, tangle-hornet
- Language: Java
- Homepage:
- Size: 161 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# tangle-hornet-monitoring
Faz a leitura e monitora o tempo de resposta em milisegundos (ms) de consultas a transações na *Tangle Hornet* a partir de um índice.
## Como utilizar
Recomendamos a utilização do Docker, mas também é possível executar o projeto através do arquivo `.jar`.
### Via Docker
Você pode utilizar a nossa imagem que está disponível no [Docker Hub](https://hub.docker.com/r/larsid/tangle-hornet-monitoring), ou fazer o *build* da imagem manualmente.
#### Build da imagem Docker:
1. Clone este projeto;
2. Acesse o diretório do projeto;
3. Digite o comando para realizar o *build* da imagem:
```powershell
docker build -t larsid/tangle-hornet-monitoring: .
```
4. Execute o container1:
```powershell
docker run -it larsid/tangle-hornet-monitoring:
```
###### Obs1: Dessa maneira irá executar com as configurações padrões. ############
### Via `.jar`
1. Clone este projeto;
2. Acesse o diretório do projeto;
3. Compile o projeto:
```powershell
mvn clean compile assembly:single
```
4. Execute o projeto2:
```powershell
java -jar target/tangle-hornet-monitoring-1.0.0-jar-with-dependencies.jar
```
###### Obs2: Dessa maneira irá executar com as configurações padrões. ############
## Sobrescrevendo as configurações padrões
### Via Docker
| Parâmetro | Descrição | Valor padrão |
| --------- | --------- | ------------ |
| API_PORT | Porta na qual a API irá executar | 3000
| NODE_URL | URL do nó da *Tangle Hornet* | 127.0.0.1
| NODE_PORT | Porta do nó da *Tangle Hornet* | 14265
| ZMQ_SOCKET_PROTOCOL | Protocolo utilizado pelo servidor ZMQ | tcp |
| ZMQ_SOCKET_URL | URL do servidor ZMQ | 127.0.0.1 |
| ZMQ_SOCKET_PORT | Porta do servidor ZMQ | 5556 |
| READ_INDEX | Índice que será utilizada para as consultas de leitura na *Tangle Hornet*. | readIndex |
| WRITE_INDEX | Índice que será utilizada para as escritas na *Tangle Hornet*. | writeIndex |
| READ_MULTIPLE_INDEX | Índice que será utilizada para as consultas de leitura de múltiplas mensagens na *Tangle Hornet*. | readMultipleIndex |
Após realizar o *build* da imagem ou utilizando a imagem disponibilizada no [Docker Hub](https://hub.docker.com/r/larsid/tangle-hornet-monitoring), basta utilizar os parâmetros acima.
#### Exemplo:
```powershell
docker run -it -e API_PORT=3000 -e NODE_URL=172.18.0.5 -e INDEX=my_index larsid/tangle-hornet-monitoring:
```
### Via `.jar`
| Parâmetro | Descrição | Valor padrão |
| --------- | --------- | ------------ |
| -apt | Porta na qual a API irá executar | 3000
| -zsp | Protocolo utilizado pelo servidor ZMQ | tcp |
| -zsu | URL do servidor ZMQ | 127.0.0.1 |
| -zspt | Porta do servidor ZMQ | 5556 |
| -ridx | Índice que será utilizada para as consultas de leitura na *Tangle Hornet*. | readIndex |
| -widx | Índice que será utilizada para as escritas na *Tangle Hornet*. | writeIndex |
| -rmiidx | Índice que será utilizada para as consultas de leitura de múltiplas mensagens na *Tangle Hornet*. | readMultipleIndex |
| -r | Monitoramento de leitura | None |
| -w | Monitoramento de escrita | None |
| -ni | Monitoramento das informações do nó da blockchain | None |
| -z | Monitoramento do ZMQ | None |
| -rmi | Monitoramento de escrita com múltiplas mensagens | None |
###### Obs: Também é possível alterar essas configurações através do arquivo [tangle-hornet-monitoring.properties](./src/main/resources/br/uefs/larsid/iot/soft/tangle-hornet-monitoring.properties) ######
Após compilar o projeto, basta utilizar os parâmetros acima.
#### Exemplo:
```powershell
java -jar target/tangle-hornet-monitoring-1.0.0-jar-with-dependencies.jar -apt 3000 -ridx my_index
```