Phoenix Analytics Documentation

To start collecting analytics data, add the PhoenixAnalytics.Plugs.RequestTracker plug to your endpoint.ex file.

Important: You must add this plug immediately after Plug.Static to ensure it captures requests correctly.

plug PhoenixAnalytics.Plugs.RequestTracker

To start the PhoenixSqlite development server, follow these steps:

1. Install dependencies: Run mix setup to install and configure all necessary project dependencies.
2. Start the server: You can start the Phoenix endpoint using the standard Mix task:

   mix phx.server

   Alternatively, start it within an interactive Elixir shell (IEx) to allow for real-time debugging:

   iex -S mix phx.server

3. Access the application: Once the server is running, visit http://localhost:4000 in your web browser.

To set up and run the PhoenixPostgres example server locally, follow these steps:

1. Install dependencies: Run mix setup to install and configure all necessary project dependencies.
2. Start the server: You can start the Phoenix endpoint using the standard Phoenix command:

   mix phx.server

   Alternatively, if you want to start the server within an interactive Elixir shell (IEx) for debugging or manual interaction, use:

   iex -S mix phx.server

3. Access the application: Once the server is running, visit http://localhost:4000 in your web browser.

To install Phoenix Analytics in your Elixir project, add phoenix_analytics to your mix.exs dependencies.

def deps do
  [
    {:phoenix_analytics, "~> 0.4"}
  ]
end

To start the Phoenix server for the PhoenixMysql example, follow these steps in your terminal:

1. Install and set up all necessary dependencies using mix setup.
2. Start the Phoenix endpoint using mix phx.server or start an interactive Elixir shell with the server running using iex -S mix phx.server.

Once started, the application is accessible at http://localhost:4000.

Phoenix Analytics uses your existing Ecto repository. Configure the :phoenix_analytics application in your configuration files (e.g., config/dev.exs) with the following keys:

• repo: Your application's Ecto Repo module.
• app_domain: The domain of your application (defaults to example.com).
• cache_ttl: Cache time-to-live in seconds (defaults to 60).

# config/dev.exs
config :phoenix_analytics,
  repo: MyApp.Repo,
  app_domain: System.get_env("PHX_HOST") || "example.com",
  cache_ttl: System.get_env("CACHE_TTL") || 60

To use Phoenix Analytics, you must configure the :phoenix_analytics application in your project's configuration files (e.g., config/config.exs or config/dev.exs).

At a minimum, you must provide your application's Ecto repository module. You can also optionally configure the application domain for filtering external referrers, the cache TTL, and the OTP application name.

config :phoenix_analytics,
  repo: MyApp.Repo,
  app_domain: "example.com",
  cache_ttl: 60,
  otp_app: :my_app

To access the analytics dashboard, add the phoenix_analytics_dashboard/2 macro to your router.ex file. This requires using the PhoenixAnalytics.Web, :router module.

use PhoenixAnalytics.Web, :router

phoenix_analytics_dashboard "/analytics"

The postgres service uses the postgres:17-alpine image. You can configure the database name, user, and password using the following environment variables:

• POSTGRES_DB: The name of the database to create (default: phoenix_postgres_dev).
• POSTGRES_USER: The superuser name (default: postgres).
• POSTGRES_PASSWORD: The superuser password (default: postgres).

The service maps port 5432 on the host to 5432 in the container and uses a named volume postgres_data for persistent storage.

postgres:
  image: postgres:17-alpine
  environment:
    POSTGRES_DB: phoenix_postgres_dev
    POSTGRES_USER: postgres
    POSTGRES_PASSWORD: postgres
  ports:
    - "5432:5432"
  volumes:
    - postgres_data:/var/lib/postgresql/data

The mysql service uses the mysql:8.4 image. You can configure the database using the following environment variables:

• MYSQL_DATABASE: The name of the database to create (default: phoenix_mysql_dev).
• MYSQL_ALLOW_EMPTY_PASSWORD: Set to true to allow connections without a password.

The service maps port 3306 on the host to 3306 in the container and uses a named volume mysql_data for persistent storage.

mysql:
  image: mysql:8.4
  environment:
    MYSQL_DATABASE: phoenix_mysql_dev
    MYSQL_ALLOW_EMPTY_PASSWORD: true
  ports:
    - "3306:3306"
  volumes:
    - mysql_data:/var/lib/mysql

The Phoenix Analytics dashboard supports keyboard shortcuts for quickly filtering data by time ranges: