Skip to content

Commit a0617e3

Browse files
AbhiPrasadcodyde
andauthored
feat: Add initial docs for logs alpha (#13603)
Co-authored-by: Cody De Arkland <[email protected]>
1 parent 3ec8447 commit a0617e3

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+530
-1
lines changed

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# Logs
2-
logs
32
*.log
43
npm-debug.log*
54
yarn-debug.log*
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
title: Set Up Logs
3+
sidebar_title: Logs
4+
description: "Structured logs allow you to send, view and query logs sent from your applications within Sentry."
5+
sidebar_order: 5755
6+
notSupported:
7+
- javascript.deno
8+
- javascript.electron
9+
- javascript.cordova
10+
- javascript.capacitor
11+
---
12+
13+
<Include name="feature-stage-alpha-logs.mdx" />
14+
15+
With Sentry Structured Logs, you can send text based log information from your applications to Sentry. Once in Sentry, these logs can be viewed alongside relevant errors, searched by text-string, or searched using their individual attributes.
16+
17+
## Requirements
18+
19+
<PlatformContent includePath="logs/requirements" />
20+
21+
## Setup
22+
23+
<PlatformContent includePath="logs/setup" />
24+
25+
## Usage
26+
27+
<PlatformContent includePath="logs/usage" />
28+
29+
## Integrations
30+
31+
<PlatformContent includePath="logs/integrations" />
32+
33+
## Options
34+
35+
<PlatformContent includePath="logs/options" />
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: Set Up Logs
3+
sidebar_title: Logs
4+
description: "Structured logs allow you to send, view and query logs sent from your applications within Sentry."
5+
sidebar_order: 5755
6+
---
7+
8+
<Include name="feature-stage-alpha-logs.mdx" />
9+
10+
With Sentry Structured Logs, you can send text based log information from your applications to Sentry. Once in Sentry, these logs can be viewed alongside relevant errors, searched by text-string, or searched using their individual attributes.
11+
12+
## Requirements
13+
14+
<PlatformContent includePath="logs/requirements" />
15+
16+
## Setup
17+
18+
<PlatformContent includePath="logs/setup" />
19+
20+
## Usage
21+
22+
<PlatformContent includePath="logs/usage" />
23+
24+
## Integrations
25+
26+
<PlatformContent includePath="logs/integrations" />
27+
28+
## Options
29+
30+
<PlatformContent includePath="logs/options" />
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
title: Set Up
3+
sidebar_order: 0
4+
description: "Learn how to set up Sentry's Logs feature using our supported SDKs."
5+
---
6+
7+
<Include name="feature-stage-alpha-logs.mdx" />
8+
9+
To set up Sentry Logs, use the links below for supported SDKs. After it's been set up, you'll be able to view and query logs and parameters sent from your applications within Sentry.
10+
11+
## Supported SDKs
12+
13+
### JavaScript
14+
15+
- [Browser JavaScript](/platforms/javascript/logs/)
16+
- [Angular](/platforms/javascript/guides/angular/logs/)
17+
- [Astro](/platforms/javascript/guides/astro/logs/)
18+
- [AWS Lambda](/platforms/javascript/guides/aws-lambda/logs/)
19+
- [Azure Functions](/platforms/javascript/guides/azure-functions/logs/)
20+
- [Bun](/platforms/javascript/guides/bun/logs/)
21+
- [Cloudflare](/platforms/javascript/guides/cloudflare/logs/)
22+
- [Connect](/platforms/javascript/guides/connect/logs/)
23+
- [Ember](/platforms/javascript/guides/ember/logs/)
24+
- [Express](/platforms/javascript/guides/express/logs/)
25+
- [Fastify](/platforms/javascript/guides/fastify/logs/)
26+
- [Gatsby](/platforms/javascript/guides/gatsby/logs/)
27+
- [Google Cloud Functions](/platforms/javascript/guides/gcp-functions/logs/)
28+
- [Hapi](/platforms/javascript/guides/hapi/logs/)
29+
- [Hono](/platforms/javascript/guides/hono/logs/)
30+
- [Koa](/platforms/javascript/guides/koa/logs/)
31+
- [Nest.js](/platforms/javascript/guides/nestjs/logs/)
32+
- [Node.js](/platforms/javascript/guides/node/logs/)
33+
- [Next.js](/platforms/javascript/guides/nextjs/logs/)
34+
- [Nuxt](/platforms/javascript/guides/nuxt/logs/)
35+
- [React](/platforms/javascript/guides/react/logs/)
36+
- [React Router](/platforms/javascript/guides/react-router/logs/)
37+
- [Remix](/platforms/javascript/guides/remix/logs/)
38+
- [Solid](/platforms/javascript/guides/solid/logs/)
39+
- [SolidStart](/platforms/javascript/guides/solidstart/logs/)
40+
- [Svelte](/platforms/javascript/guides/svelte/logs/)
41+
- [SvelteKit](/platforms/javascript/guides/sveltekit/logs/)
42+
- [TanStack Start](/platforms/javascript/guides/tanstackstart-react/logs/)
43+
- [Vue](/platforms/javascript/guides/vue/logs/)
44+
- [Wasm](/platforms/javascript/guides/wasm/logs/)
45+
46+
### Python
47+
48+
- [Python](/platforms/python/logs/)
49+
50+
## Upcoming SDKs
51+
52+
We're actively working on adding Log functionality to additional SDKs. Check out these GitHub issues for the latest updates:
53+
54+
- [PHP](https://github.com/getsentry/sentry-php/issues/1824)
55+
- [Java](https://github.com/getsentry/sentry-java/issues/4350)
56+
- [Go](https://github.com/getsentry/sentry-go/issues/1000)
57+
- [Ruby](https://github.com/getsentry/sentry-ruby/issues/2600)
58+
- [.NET](https://github.com/getsentry/sentry-dotnet/issues/4132)
59+
- [Dart/Flutter](https://github.com/getsentry/sentry-dart/issues/2915)
60+
- [Native C/C++](https://github.com/getsentry/sentry-native/issues/1210)
61+
- [Cocoa (iOS)](https://github.com/getsentry/sentry-cocoa/issues/5122)
62+
- [Deno](https://github.com/getsentry/sentry-javascript/issues/15988)
63+
- [Rust](https://github.com/getsentry/sentry-rust/issues/785)
64+
- [Elixir](https://github.com/getsentry/sentry-elixir/issues/886)
65+
66+
If you don't see your platform listed above, please reach out to us on [GitHub](https://github.com/getsentry/sentry/discussions/86804) or [Discord](https://discord.gg/sentry), we'll get it prioritized!
497 KB
Loading
450 KB
Loading
485 KB
Loading
679 KB
Loading
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
title: "Logs"
3+
sidebar_order: 70
4+
description: "Structured logs allow you to send, view and query logs and parameters sent from your applications within Sentry."
5+
---
6+
7+
<Include name="feature-stage-alpha-logs.mdx" />
8+
9+
## Overview
10+
11+
With Structured Logs, users can send text based log information from their applications, whether frontend or backend, to Sentry. Once in Sentry, these logs can be viewed alongside relevant errors, searched by text-string, or searched using their individual parameters.
12+
13+
<Arcade src="https://demo.arcade.software/PalOCHofpcO3DqvA4Rzr?embed" />
14+
15+
Not everything that you want to track in your application generates an error event. You might want to arbitrarily track information happening in your application for many reasons, such as:
16+
17+
- Debugging information like navigation actions, page interactions, or query results
18+
- User specific events
19+
- Configuration items that users or an application are receiving
20+
21+
## Set up Logs
22+
23+
To get started with Logs, navigate to the [Gettting Started](/product/explore/logs/getting-started/) and select your SDK from the list.
24+
25+
## Viewing and Searching Logs
26+
27+
Raw text search is case sensitive and allows you to search for specific strings within log entries.
28+
29+
![Raw Text Logs Search](./img/LogSearchRawText.png)
30+
31+
You can also search using the default properties (like `severity`) or additional custom properties that you've added to your log entries.
32+
33+
![Property Logs Search](./img/LogSearchTags.png)
34+
35+
Log entries can be expanded to view all properties of logs entry. Individual properties can be added as columns to the results view, allowing you to quickly view properties that matter specifically to you alongside your search results.
36+
37+
![Expanded Logs View](./img/LogsExpanded.png)
38+
39+
## Video - Getting Started with Sentry Logs
40+
41+
<VimeoEmbed id="1081149414?h=4094d6e14f" />
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
<Alert title="Now in Alpha!">
2+
3+
Sentry Logs is currently in a closed alpha. Features are still in-progress and may have bugs. We recognize the irony.
4+
If you want early access, or have any feedback or questions, you can reach out to us on [GitHub](https://github.com/getsentry/sentry/discussions/86804), [email](mailto:[email protected]) or [Discord](https://discord.gg/sentry).
5+
6+
</Alert>

0 commit comments

Comments
 (0)