You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Ftinybirdco%2Flogs-explorer-template&project-name=tinybird-logs-explorer-template&repository-name=tinybird-logs-explorer-template&demo-description=Custom%20logs%20explorer%20for%20your%20application%20logs%20using%20Tinybird&demo-url=http%3A%2F%2Flogs.tinybird.app&demo-image=//github.com/tinybirdco/logs-explorer-template/blob/main/dashboard/log-analyzer/public/banner.png?raw=true&root-directory=dashboard/log-analyzer)
Copy file name to clipboardExpand all lines: TEMPLATE.md
+15-62Lines changed: 15 additions & 62 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,65 +2,31 @@ This is a template for a Logs Explorer web application. It is built with Next.js
2
2
3
3
Use this template to bootstrap a multi-tenant, user-facing logs explorer for any software project. Fork it and make it your own!
4
4
5
-
## Quick Start
5
+
## Set up the project
6
6
7
-
Deploy the project to [Tinybird](https://app.tinybird.co?starter_kit=https://github.com/tinybirdco/logs-explorer-template/tinybird)and [Vercel](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Ftinybirdco%2Flogs-explorer-template&project-name=tinybird-logs-explorer-template&repository-name=tinybird-logs-explorer-template&demo-description=Custom%20logs%20explorer%20for%20your%20application%20logs%20using%20Tinybird&demo-url=http%3A%2F%2Flogs.tinybird.app&demo-image=//github.com/tinybirdco/logs-explorer-template/blob/main/dashboard/log-analyzer/public/banner.png?raw=true&root-directory=dashboard/log-analyzer) to get started quickly.
7
+
Fork the GitHub repository and deploy the data project to Tinybird.
8
8
9
-
Configure your Tinybird environment variables in Vercel:
Deploy the [dashboard to Vercel](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Ftinybirdco%2Flogs-explorer-template&project-name=tinybird-logs-explorer-template&repository-name=tinybird-logs-explorer-template&demo-description=Custom%20logs%20explorer%20for%20your%20application%20logs%20using%20Tinybird&demo-url=http%3A%2F%2Flogs.tinybird.app&demo-image=//github.com/tinybirdco/logs-explorer-template/blob/main/dashboard/log-analyzer/public/banner.png?raw=true&root-directory=dashboard/log-analyzer)
54
21
55
-
Open the application in your browser:
22
+
Configure your Tinybird environment variables in Vercel:
Read the [dashboard/log-analyzer/README.md](https://github.com/tinybirdco/logs-explorer-template/blob/main/dashboard/log-analyzer/README.md) file for more information on how to use the application and [tinybird/README.md](https://github.com/tinybirdco/logs-explorer-template/blob/main/tinybird/README.md) for more information on how to customize the template.
62
-
63
-
## Instrumenting your application
29
+
## Instrument your application
64
30
65
31
To instrument your application, just send JSON objects to the Tinybird [Events API](https://www.tinybird.co/docs/get-data-in/ingest-apis/events-api).
66
32
@@ -101,19 +67,6 @@ You can use Vector to collect logs from different sources and send them to a Tin
101
67
102
68
Check the [examples/vector](https://github.com/tinybirdco/logs-explorer-template/tree/main/examples/vector) folder for an example of how to do this with Vector.
103
69
104
-
## Deployment
105
-
106
-
Deploy the Tinybird project to the cloud:
107
-
108
-
```sh
109
-
cd tinybird
110
-
tb --cloud deploy
111
-
```
112
-
113
-
Once deployed copy your Tinybird cloud host and `read_pipes` token, [deploy the Next.js application to Vercel](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Ftinybirdco%2Flogs-explorer-template&project-name=tinybird-logs-explorer-template&repository-name=tinybird-logs-explorer-template&demo-description=Custom%20logs%20explorer%20for%20your%20application%20logs%20using%20Tinybird&demo-url=http%3A%2F%2Flogs.tinybird.app&demo-image=//github.com/tinybirdco/logs-explorer-template/blob/main/dashboard/log-analyzer/public/banner.png?raw=true&root-directory=dashboard/log-analyzer) and configure the environment variables.
114
-
115
-
## Customizing the template
116
-
117
-
You can use the template as a starting point to build your own logs explorer application or embed components in your own application.
70
+
## Local Development, multi-tenancy and more
118
71
119
-
See how it's done in the [Vercel Log Drains template](https://github.com/alrocar/vercel-logs-explorer-template) and the [Auth0 Log Streams template](https://github.com/tinybirdco/auth0-logs-explorer-template).
72
+
See the GitHub repository [README.md](https://github.com/tinybirdco/logs-explorer-template)
0 commit comments