Setting up Metronome in an Architect project
As Remix Grunge Stack uses Architect, this guide can also be used to install Metronome in that stack.
0. Install Remix with the Architect adapter
If you have already installed Remix, you can skip this section.
npx create-remix@latest
- Name your project (e.g. "my-remix-app")
- After you name your project, select
Just the basics
and press enter. - Select
Architect (AWS Lambda)
and press enter.
1. Install Metronome
Install Metronome React and Architect packages
npm install @metronome-sh/react @metronome-sh/architect
2. Initialize Metronome
To create Metronome's metronome.config.js
file, you need to run the init
command.
npx metronome init
3. Configure Metronome in your server.js file
- Import
createMetronomeGetLoadContext
andregisterMetronome
from the@metronome-sh/architect
module in your server.js file.
import {createMetronomeGetLoadContext,registerMetronome,} from "@metronome-sh/architect";
- Register Metronome in the build by using the
registerMetronome
function in your server.js file.
const buildWithMetronome = registerMetronome(build);
- create the
getLoadContext
function usingcreateMetronomeGetLoadContext
withbuildWithMetronome
as first argument and also the config file import as an option.
const metronomeGetLoadContext = createMetronomeGetLoadContext(buildWithMetronome,{ config: require("./metronome.config.js") });
- In the
createRequestHandler
function, replace thebuild
prop withbuildWithMetronome
and add thegetLoadContext
prop withmetronomeGetLoadContext
:
export const handler = createRequestHandler({build: buildWithMetronome,mode: process.env.NODE_ENV,getLoadContext: metronomeGetLoadContext,});
Your server.js file should now look like this:
import {createMetronomeGetLoadContext,registerMetronome,} from "@metronome-sh/architect";import { createRequestHandler } from "@remix-run/architect";import * as build from "@remix-run/dev/server-build";const buildWithMetronome = registerMetronome(build);const metronomeGetLoadContext = createMetronomeGetLoadContext(buildWithMetronome,{ config: require("./metronome.config.js") });export const handler = createRequestHandler({build: buildWithMetronome,mode: process.env.NODE_ENV,getLoadContext: metronomeGetLoadContext,});
Using multiple getLoadContext
If you already have a getLoadContext
function, you can combine Metronome's
getLoadContext with your existing by importing the combineGetLoadContexts
helper:
import {createMetronomeGetLoadContext,registerMetronome,} from "@metronome-sh/architect";import { createRequestHandler } from "@remix-run/architect";import * as build from "@remix-run/dev/server-build";const buildWithMetronome = registerMetronome(build);const metronomeGetLoadContext = createMetronomeGetLoadContext(buildWithMetronome,{ config: require("./metronome.config.js") });// ... your other getLoadContext functions ...export const handler = createRequestHandler({build: buildWithMetronome,mode: process.env.NODE_ENV,// Combine your existing getLoadContext with Metronome'sgetLoadContext: combineGetLoadContexts(getLoadContext,metronomeGetLoadContext),});
4. Configure Metronome in your root.tsx file
After you have configured the server side of Metronome in your app, you need to set up the client side with @metronome-sh/react
to be able to track your app's Web Vitals.
Simply import MetronomeLinks
from @metronome-sh/react
:
import { MetronomeLinks } from "@metronome-sh/react";
You should render the <MetronomeLinks />
component between your <head>
tags.
export default function App() {return (<html lang="en"><head><Meta /><Links /><MetronomeLinks /></head><body><Outlet /><ScrollRestoration /><Scripts /><LiveReload /></body></html>);}
5. Create a new project in Metronome
To create a new project, please follow the instructions in the Creating a new project section.
6. Set your API key in your production environment
After you created you new project in https://metronome.sh, you need to add the METRONOME_API_KEY
environment variable in the production
environment:
arc env production METRONOME_API_KEY {project-api-key}
For more information, please see the Architect docs
Deploy your project
Once you have your METRONOME_API_KEY
set up, deploy your project to production, after your first couple of visits, you should be able to see metrics.