Skip to content

Commit a330700

Browse files
laulaulandlaulauland
authored
New landing pages (#52)
* update deploy cover page (remove component specific in favor of overall) * update overall landing page
1 parent ce84252 commit a330700

File tree

3 files changed

+170
-2
lines changed

3 files changed

+170
-2
lines changed

‎src/pages/_meta.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
"type": "separator",
3131
"title": "Deployment"
3232
},
33+
"deploy": "Autometrics Stack",
3334
"deploying-prometheus": "Prometheus",
3435
"deploying-explorer": "Explorer",
3536
"deploying-alertmanager": "Alertmanager",

‎src/pages/deploy.mdx

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
import { Cards, Card } from "nextra-theme-docs"
2+
3+
# Deploying Autometrics Stack
4+
5+
The Autometrics Stack is an open-source application observability stack focused on simple instrumentation, metrics, and alerting.
6+
7+
The Autometrics Stack contains the following components:
8+
- Autometrics libraries for instrumenting code
9+
- [OpenTelemetry](https://opentelemetry.io/) - for underlying instrumentation (and optionally collecting)
10+
- [Prometheus](https://prometheus.io) + [Alertmanager](https://prometheus.io/docs/alerting/latest/alertmanager/) for metrics storage, querying, and alerting
11+
- Explorer for visualizing Autometrics data
12+
- Slack Application for better alert workflows between Prometheus and Slack
13+
14+
Each of these components can be easily adopted and deployed to a hosting option of your choice (components are available as Docker images for ease of use):
15+
16+
### Prometheus
17+
18+
<Cards num={2}>
19+
<Card
20+
children
21+
icon
22+
title="Kubernetes"
23+
href="/deploying-prometheus/kubernetes"
24+
/>
25+
<Card
26+
children
27+
icon
28+
title="Docker"
29+
href="/deploying-prometheus/docker"
30+
/>
31+
<Card
32+
children
33+
icon
34+
title="Northflank"
35+
href="/deploying-prometheus/northflank"
36+
/>
37+
<Card
38+
children
39+
icon
40+
title="Railway"
41+
href="/deploying-prometheus/railway"
42+
/>
43+
</Cards>
44+
45+
### OpenTelemetry Collector
46+
47+
<Cards num={2}>
48+
<Card
49+
children
50+
icon
51+
title="Kubernetes"
52+
href="/deploying-opentelemetry-collector/kubernetes"
53+
/>
54+
<Card
55+
children
56+
icon
57+
title="Docker"
58+
href="/deploying-opentelemetry-collector/docker"
59+
/>
60+
<Card
61+
children
62+
icon
63+
title="Northflank"
64+
href="/deploying-opentelemetry-collector/northflank"
65+
/>
66+
<Card
67+
children
68+
icon
69+
title="Railway"
70+
href="/deploying-opentelemetry-collector/railway"
71+
/>
72+
</Cards>
73+
74+
### Explorer
75+
76+
<Cards num={2}>
77+
<Card
78+
children
79+
icon
80+
title="Kubernetes"
81+
href="/deploying-explorer/kubernetes"
82+
/>
83+
<Card
84+
children
85+
icon
86+
title="Docker"
87+
href="/deploying-explorer/docker"
88+
/>
89+
<Card
90+
children
91+
icon
92+
title="Northflank"
93+
href="/deploying-explorer/northflank"
94+
/>
95+
<Card
96+
children
97+
icon
98+
title="Railway"
99+
href="/deploying-explorer/railway"
100+
/>
101+
</Cards>
102+
103+
### Alertmanager
104+
105+
<Cards num={2}>
106+
<Card
107+
children
108+
icon
109+
title="Kubernetes"
110+
href="/deploying-alertmanager/kubernetes"
111+
/>
112+
<Card
113+
children
114+
icon
115+
title="Docker"
116+
href="/deploying-alertmanager/docker"
117+
/>
118+
<Card
119+
children
120+
icon
121+
title="Northflank"
122+
href="/deploying-alertmanager/northflank"
123+
/>
124+
<Card
125+
children
126+
icon
127+
title="Railway"
128+
href="/deploying-alertmanager/railway"
129+
/>
130+
</Cards>

‎src/pages/index.mdx

Lines changed: 39 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { Cards, Card } from "nextra-theme-docs";
1+
import { Cards, Card, Steps } from "nextra-theme-docs";
22

33
# What is Autometrics?
44

@@ -8,7 +8,9 @@ To make it easy for you to spot and debug issues in production, Autometrics inse
88

99
Autometrics is built on the excellent Prometheus and OpenTelemetry open source projects.
1010

11-
### Demo
11+
## Demo
12+
13+
Here's a simple overview video for Autometrics
1214

1315
<p>
1416
<video
@@ -22,6 +24,12 @@ Autometrics is built on the excellent Prometheus and OpenTelemetry open source p
2224

2325
## Getting started
2426

27+
You can start working with Autometrics as early as the first lines of your code and it can take you as far as alerting about issues in your team's Slack workspace. Here are the basic steps to get you started:
28+
29+
<Steps>
30+
31+
### Install the library
32+
2533
Autometrics is currently available in Rust, JavaScript/TypeScript, and
2634
Python, Go. To get started, follow the instructions for each language:
2735

@@ -31,3 +39,32 @@ Python, Go. To get started, follow the instructions for each language:
3139
<Card arrow title="Go" href="/go/quickstart" />
3240
<Card arrow title="Python" href="/python/quickstart" />
3341
</Cards>
42+
43+
### Install Prometheus + Alertmanager
44+
45+
Autometrics libraries export metrics in a Prometheus-compatible format. In order to store and query them you can deploy a Prometheus server in your stack
46+
47+
<Cards num={2}>
48+
<Card arrow title="Kubernetes" href="/deploying-prometheus/kubernetes" />
49+
<Card arrow title="Docker" href="/deploying-prometheus/docker" />
50+
</Cards>
51+
52+
### Deploy Explorer
53+
54+
Autometrics Explorer is a special interface that connects with your Prometheus and helps you analyze your Autometrics-generated data more easily. It is a simple client app available at explorer.autometrics.dev or deployable as a Docker image as well.
55+
56+
<Cards num={2}>
57+
<Card arrow title="Kubernetes" href="/deploying-explorer/kubernetes" />
58+
<Card arrow title="Docker" href="/deploying-explorer/docker" />
59+
</Cards>
60+
61+
### Deploy Slack application
62+
63+
Finally, Autometrics includes a special-built Slack application that connects with your Prometheus Alertmanager and offers a simple workflow for monitoring and responding to alerts.
64+
65+
<Cards num={2}>
66+
<Card arrow title="Kubernetes" href="/deploying-alertmanager/kubernetes" />
67+
<Card arrow title="Docker" href="/deploying-alertmanager/docker" />
68+
</Cards>
69+
70+
</Steps>

0 commit comments

Comments
 (0)