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

refactor(tracker): rewrite operator tracker in elixir #1000

Draft
wants to merge 7 commits into
base: staging
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -722,3 +722,38 @@ tracker_dump_db:
@cd operator_tracker && \
docker exec -t tracker-postgres-container pg_dumpall -c -U tracker_user > dump.$$(date +\%Y\%m\%d_\%H\%M\%S).sql
@echo "Dumped database successfully to /operator_tracker"

__TELEMETRY__:
open_telemetry_start: ## Run open telemetry services using telemetry-docker-compose.yaml
## TODO(juarce) ADD DOCKER COMPOSE
@echo "Running telemetry..."
@docker compose -f telemetry-docker-compose.yaml up -d

telemetry_start: telemetry_ecto_migrate ## Run Telemetry API
@cd telemetry_api && \
mix phx.server

telemetry_ecto_migrate: ##
@cd telemetry_api && \
mix ecto.migrate

telemetry_build_db:
@cd telemetry_api && \
docker build -t telemetry-postgres-image .

telemetry_run_db: telemetry_build_db telemetry_remove_db_container
@cd telemetry_api && \
docker run -d --name telemetry-postgres-container -p 5434:5432 -v telemetry-postgres-data:/var/lib/postgresql/data telemetry-postgres-image

telemetry_remove_db_container:
@docker stop telemetry-postgres-container || true && \
docker rm telemetry-postgres-container || true

telemetry_clean_db: telemetry_remove_db_container
@docker volume rm telemetry-postgres-data || true

telemetry_dump_db:
@cd telemetry_api && \
docker exec -t telemetry-postgres-container pg_dumpall -c -U tracker_user > dump.$$(date +\%Y\%m\%d_\%H\%M\%S).sql
@echo "Dumped database successfully to /telemetry_api"

2 changes: 1 addition & 1 deletion config-files/config-operator-1.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ bls:
## Operator Configurations
operator:
aggregator_rpc_server_ip_port_address: localhost:8090
operator_tracker_ip_port_address: http://localhost:3030
operator_tracker_ip_port_address: http://localhost:4000
address: 0x70997970C51812dc3A010C7d01b50e0d17dc79C8
earnings_receiver_address: 0x70997970C51812dc3A010C7d01b50e0d17dc79C8
delegation_approver_address: "0x0000000000000000000000000000000000000000"
Expand Down
2 changes: 1 addition & 1 deletion operator/cmd/actions/start.go
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ func operatorMain(ctx *cli.Context) error {
}

// send version to operator tracker server
endpoint := operatorConfig.Operator.OperatorTrackerIpPortAddress + "/versions"
endpoint := operatorConfig.Operator.OperatorTrackerIpPortAddress + "/api/operators"
operator.Logger.Info("Sending version to operator tracker server: ", "endpoint", endpoint)

res, err := http.Post(endpoint, "application/json",
Expand Down
5 changes: 5 additions & 0 deletions telemetry_api/.formatter.exs
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[
import_deps: [:ecto, :ecto_sql, :phoenix],
subdirectories: ["priv/*/migrations"],
inputs: ["*.{ex,exs}", "{config,lib,test}/**/*.{ex,exs}", "priv/*/seeds.exs"]
]
27 changes: 27 additions & 0 deletions telemetry_api/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# The directory Mix will write compiled artifacts to.
/_build/

# If you run "mix test --cover", coverage assets end up here.
/cover/

# The directory Mix downloads your dependencies sources to.
/deps/

# Where 3rd-party dependencies like ExDoc output generated docs.
/doc/

# Ignore .fetch files in case you like to edit your project deps locally.
/.fetch

# If the VM crashes, it generates a dump, let's ignore it too.
erl_crash.dump

# Also ignore archive artifacts (built via "mix archive.build").
*.ez

# Temporary files, for example, from tests.
/tmp/

# Ignore package tarball (built via "mix hex.build").
telemetry_api-*.tar

10 changes: 10 additions & 0 deletions telemetry_api/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# https://hub.docker.com/_/postgres
FROM postgres:16.3

# Environment variables
ENV POSTGRES_USER=telemetry_user
ENV POSTGRES_PASSWORD=telemetry_pass
ENV POSTGRES_DB=telemetry_db

# Expose the default PostgreSQL port
EXPOSE 5432
55 changes: 55 additions & 0 deletions telemetry_api/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# TelemetryApi

## Database Setup

To create a Postgres container and run it:

```shell
make telemetry_run_db
```

This will create and run the container using the credentials set in `Dockerfile`

> [!CAUTION]
> Do not use default credentials in Production environments.

### Delete database

If you want to delete the container:

```shell
make telemetry_remove_db_container
```

This will remove the container but will keep the storage

If you also want to delete the storage run:

```shell
make telemetry_clean_db
```

## Run Server

To start your Phoenix server:

```shell
make telemetry_start
```

On startup, it will run ecto migrations.

* Run `mix setup` to install and setup dependencies
* Start Phoenix endpoint with `mix phx.server` or inside IEx with `iex -S mix phx.server`

Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.

## Database Migrations

This API uses Ecto for migrations. To apply migrations, run:

```shell
make telemetry_ecto_migrate
```


35 changes: 35 additions & 0 deletions telemetry_api/config/config.exs
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# This file is responsible for configuring your application
# and its dependencies with the aid of the Config module.
#
# This configuration file is loaded before any dependency and
# is restricted to this project.

# General application configuration
import Config

config :telemetry_api,
ecto_repos: [TelemetryApi.Repo],
generators: [timestamp_type: :utc_datetime]

# Configures the endpoint
config :telemetry_api, TelemetryApiWeb.Endpoint,
url: [host: "localhost"],
adapter: Bandit.PhoenixAdapter,
render_errors: [
formats: [json: TelemetryApiWeb.ErrorJSON],
layout: false
],
pubsub_server: TelemetryApi.PubSub,
live_view: [signing_salt: "eQaI7lMW"]

# Configures Elixir's Logger
config :logger, :console,
format: "$time $metadata[$level] $message\n",
metadata: [:request_id]

# Use Jason for JSON parsing in Phoenix
config :phoenix, :json_library, Jason

# Import environment specific config. This must remain at the bottom
# of this file so it overrides the configuration defined above.
import_config "#{config_env()}.exs"
64 changes: 64 additions & 0 deletions telemetry_api/config/dev.exs
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
import Config

# Configure your database
config :telemetry_api, TelemetryApi.Repo,
username: "telemetry_user",
password: "telemetry_pass",
database: "telemetry_db",
hostname: "localhost",
port: 5434,
stacktrace: true,
show_sensitive_data_on_connection_error: true,
pool_size: 10

# For development, we disable any cache and enable
# debugging and code reloading.
#
# The watchers configuration can be used to run external
# watchers to your application. For example, we can use it
# to bundle .js and .css sources.
config :telemetry_api, TelemetryApiWeb.Endpoint,
# Binding to loopback ipv4 address prevents access from other machines.
# Change to `ip: {0, 0, 0, 0}` to allow access from other machines.
http: [ip: {127, 0, 0, 1}, port: 4000],
check_origin: false,
code_reloader: true,
debug_errors: true,
secret_key_base: "SKxKWZhd8cfUXMUqskUHvegw8P46kkfwIYWTW86tsqn+t6M2S1HUFjTqgVWAkvX0",
watchers: []

# ## SSL Support
#
# In order to use HTTPS in development, a self-signed
# certificate can be generated by running the following
# Mix task:
#
# mix phx.gen.cert
#
# Run `mix help phx.gen.cert` for more information.
#
# The `http:` config above can be replaced with:
#
# https: [
# port: 4001,
# cipher_suite: :strong,
# keyfile: "priv/cert/selfsigned_key.pem",
# certfile: "priv/cert/selfsigned.pem"
# ],
#
# If desired, both `http:` and `https:` keys can be
# configured to run both http and https servers on
# different ports.

# Enable dev routes for dashboard and mailbox
config :telemetry_api, dev_routes: true

# Do not include metadata nor timestamps in development logs
config :logger, :console, format: "[$level] $message\n"

# Set a higher stacktrace during development. Avoid configuring such
# in production as building large stacktraces may be expensive.
config :phoenix, :stacktrace_depth, 20

# Initialize plugs at runtime for faster development compilation
config :phoenix, :plug_init_mode, :runtime
7 changes: 7 additions & 0 deletions telemetry_api/config/prod.exs
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import Config

# Do not print debug messages in production
config :logger, level: :info

# Runtime production configuration, including reading
# of environment variables, is done on config/runtime.exs.
99 changes: 99 additions & 0 deletions telemetry_api/config/runtime.exs
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
import Config

# config/runtime.exs is executed for all environments, including
# during releases. It is executed after compilation and before the
# system starts, so it is typically used to load production configuration
# and secrets from environment variables or elsewhere. Do not define
# any compile-time configuration in here, as it won't be applied.
# The block below contains prod specific runtime configuration.

# ## Using releases
#
# If you use `mix release`, you need to explicitly enable the server
# by passing the PHX_SERVER=true when you start it:
#
# PHX_SERVER=true bin/telemetry_api start
#
# Alternatively, you can use `mix phx.gen.release` to generate a `bin/server`
# script that automatically sets the env var above.
if System.get_env("PHX_SERVER") do
config :telemetry_api, TelemetryApiWeb.Endpoint, server: true
end

if config_env() == :prod do
database_url =
System.get_env("DATABASE_URL") ||
raise """
environment variable DATABASE_URL is missing.
For example: ecto://USER:PASS@HOST/DATABASE
"""

maybe_ipv6 = if System.get_env("ECTO_IPV6") in ~w(true 1), do: [:inet6], else: []

config :telemetry_api, TelemetryApi.Repo,
# ssl: true,
url: database_url,
pool_size: String.to_integer(System.get_env("POOL_SIZE") || "10"),
socket_options: maybe_ipv6

# The secret key base is used to sign/encrypt cookies and other secrets.
# A default value is used in config/dev.exs and config/test.exs but you
# want to use a different value for prod and you most likely don't want
# to check this value into version control, so we use an environment
# variable instead.
secret_key_base =
System.get_env("SECRET_KEY_BASE") ||
raise """
environment variable SECRET_KEY_BASE is missing.
You can generate one by calling: mix phx.gen.secret
"""

host = System.get_env("PHX_HOST") || "example.com"
port = String.to_integer(System.get_env("PORT") || "4000")

config :telemetry_api, :dns_cluster_query, System.get_env("DNS_CLUSTER_QUERY")

config :telemetry_api, TelemetryApiWeb.Endpoint,
url: [host: host, port: 443, scheme: "https"],
http: [
# Enable IPv6 and bind on all interfaces.
# Set it to {0, 0, 0, 0, 0, 0, 0, 1} for local network only access.
# See the documentation on https://hexdocs.pm/bandit/Bandit.html#t:options/0
# for details about using IPv6 vs IPv4 and loopback vs public addresses.
ip: {0, 0, 0, 0, 0, 0, 0, 0},
port: port
],
secret_key_base: secret_key_base

# ## SSL Support
#
# To get SSL working, you will need to add the `https` key
# to your endpoint configuration:
#
# config :telemetry_api, TelemetryApiWeb.Endpoint,
# https: [
# ...,
# port: 443,
# cipher_suite: :strong,
# keyfile: System.get_env("SOME_APP_SSL_KEY_PATH"),
# certfile: System.get_env("SOME_APP_SSL_CERT_PATH")
# ]
#
# The `cipher_suite` is set to `:strong` to support only the
# latest and more secure SSL ciphers. This means old browsers
# and clients may not be supported. You can set it to
# `:compatible` for wider support.
#
# `:keyfile` and `:certfile` expect an absolute path to the key
# and cert in disk or a relative path inside priv, for example
# "priv/ssl/server.key". For all supported SSL configuration
# options, see https://hexdocs.pm/plug/Plug.SSL.html#configure/1
#
# We also recommend setting `force_ssl` in your config/prod.exs,
# ensuring no data is ever sent via http, always redirecting to https:
#
# config :telemetry_api, TelemetryApiWeb.Endpoint,
# force_ssl: [hsts: true]
#
# Check `Plug.SSL` for all available options in `force_ssl`.
end
27 changes: 27 additions & 0 deletions telemetry_api/config/test.exs
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
import Config

# Configure your database
#
# The MIX_TEST_PARTITION environment variable can be used
# to provide built-in test partitioning in CI environment.
# Run `mix help test` for more information.
config :telemetry_api, TelemetryApi.Repo,
username: "postgres",
password: "postgres",
hostname: "localhost",
database: "telemetry_api_test#{System.get_env("MIX_TEST_PARTITION")}",
pool: Ecto.Adapters.SQL.Sandbox,
pool_size: System.schedulers_online() * 2

# We don't run a server during test. If one is required,
# you can enable the server option below.
config :telemetry_api, TelemetryApiWeb.Endpoint,
http: [ip: {127, 0, 0, 1}, port: 4002],
secret_key_base: "oxlWGXR4lI6jsDZfizxmFwhPFn9vjc6rWqsdAnu5rlTmluTstw3/6YBkB5OGKi5m",
server: false

# Print only warnings and errors during test
config :logger, level: :warning

# Initialize plugs at runtime for faster test compilation
config :phoenix, :plug_init_mode, :runtime
Loading