Skip to content

Commit

Permalink
Rename files to not have numeric prefixes (#39)
Browse files Browse the repository at this point in the history
  • Loading branch information
dmontagu authored Apr 30, 2024
1 parent 971c59c commit 25e031c
Show file tree
Hide file tree
Showing 20 changed files with 36 additions and 36 deletions.
File renamed without changes.
12 changes: 6 additions & 6 deletions docs/guides/advanced/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
* **[Sampling](01_sampling.md):** Discard some traces or spans to manage data storage and analysis efficiently, including setting up the `trace_sample_rate`.
* **[Scrubbing](02_scrubbing.md):** Automatically redact sensitive information from your logs and spans using customizable patterns and callbacks.
* **[Testing](03_testing.md):** Verify your application's logging and span tracking with Logfire's testing utilities, ensuring accurate data capture and observability.
* **[Backfill](04_backfill.md):** Recover lost data and bulk load historical data into Logfire with the `logfire backfill` command, ensuring data continuity.
* **[Creating Write Tokens](05_creating_write_tokens.md):** Generate and manage multiple write tokens for different services.
* **[Direct Database Connections](06_direct_database_connections.md):** Set up read-only credentials for direct database queries, facilitating custom analyses and integrations with third-party SQL and dashboarding tools.
* **[Sampling](sampling.md):** Discard some traces or spans to manage data storage and analysis efficiently, including setting up the `trace_sample_rate`.
* **[Scrubbing](scrubbing.md):** Automatically redact sensitive information from your logs and spans using customizable patterns and callbacks.
* **[Testing](testing.md):** Verify your application's logging and span tracking with Logfire's testing utilities, ensuring accurate data capture and observability.
* **[Backfill](backfill.md):** Recover lost data and bulk load historical data into Logfire with the `logfire backfill` command, ensuring data continuity.
* **[Creating Write Tokens](creating_write_tokens.md):** Generate and manage multiple write tokens for different services.
* **[Direct Database Connections](direct_database_connections.md):** Set up read-only credentials for direct database queries, facilitating custom analyses and integrations with third-party SQL and dashboarding tools.
File renamed without changes.
File renamed without changes.
File renamed without changes.
8 changes: 4 additions & 4 deletions docs/guides/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,10 @@ to investigate your projects' data.

We cover additional topics in the **[Advanced User Guide](advanced/index.md)**, including:

* **[Sampling](advanced/01_sampling.md/#sampling):** Down-sample lower-priority traces to reduce costs.
* **[Scrubbing](advanced/02_scrubbing.md):** Remove sensitive data from your logs and traces before sending them to Logfire.
* **[Testing](advanced/03_testing.md):** Test your usage of Logfire.
* **[Direct Database Connections](advanced/06_direct_database_connections.md):** Connect directly to a read-only postgres
* **[Sampling](advanced/sampling.md/#sampling):** Down-sample lower-priority traces to reduce costs.
* **[Scrubbing](advanced/scrubbing.md):** Remove sensitive data from your logs and traces before sending them to Logfire.
* **[Testing](advanced/testing.md):** Test your usage of Logfire.
* **[Direct Database Connections](advanced/direct_database_connections.md):** Connect directly to a read-only postgres
database containing your project's data. You can use this for ad-hoc querying, or with third-party
business intelligence tools like Grafana, Tableau, Metabase, etc.
* ... and more.
Expand Down
10 changes: 5 additions & 5 deletions docs/guides/onboarding_checklist/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,19 @@ fix bugs, analyze user behavior, and make data-driven decisions.

#### Logfire Onboarding Checklist

* [ ] **[Create a Logfire project for your application](01_create_a_project.md)**: Set up a dedicated project in Logfire
* [ ] **[Create a Logfire project for your application](create_a_project.md)**: Set up a dedicated project in Logfire
to organize and manage your application's data.

* [ ] **[Integrate Logfire](02_integrate.md)**: Fully integrate Logfire with your logging system and the packages you are
* [ ] **[Integrate Logfire](integrate.md)**: Fully integrate Logfire with your logging system and the packages you are
using.

* [ ] **[Add Logfire manual tracing](03_add_manual_tracing.md)**: Enhance your tracing data by manually adding custom
* [ ] **[Add Logfire manual tracing](add_manual_tracing.md)**: Enhance your tracing data by manually adding custom
spans and logs to your code for more targeted data collection.

* [ ] **[Add Logfire auto-tracing](04_add_auto_tracing.md)**: Discover how to leverage Logfire's auto-tracing
* [ ] **[Add Logfire auto-tracing](add_auto_tracing.md)**: Discover how to leverage Logfire's auto-tracing
capabilities to automatically instrument your application with minimal code changes.

* [ ] **[Add Logfire metrics](05_add_metrics.md)**: Learn how to create and use metrics to track and measure important
* [ ] **[Add Logfire metrics](add_metrics.md)**: Learn how to create and use metrics to track and measure important
aspects of your application's performance and behavior.

We'll walk you through the checklist step by step, introducing relevant features and concepts as we go. While the main
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
8 changes: 4 additions & 4 deletions docs/guides/web_ui/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
* **[Live](01_live.md):** View your logs as nested traces, and use SQL filters to browse live or historical data.
* **[Dashboards](02_dashboards.md):** Build dashboards to visualize your traces and metrics.
* **[Alerts](03_alerts.md):** Set up alerts triggered by events related to your traces and metrics.
* **[Explore](04_explore.md):** Run arbitrary SQL queries against your traces and metrics, and export the results.
* **[Live](live.md):** View your logs as nested traces, and use SQL filters to browse live or historical data.
* **[Dashboards](dashboards.md):** Build dashboards to visualize your traces and metrics.
* **[Alerts](alerts.md):** Set up alerts triggered by events related to your traces and metrics.
* **[Explore](explore.md):** Run arbitrary SQL queries against your traces and metrics, and export the results.

[//]: # ( * Create and using database credentials for direct connection)
4 changes: 2 additions & 2 deletions docs/guides/web_ui/01_live.md → docs/guides/web_ui/live.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This is what you'll see when you come to the live view of a project with some da

1. **Organization and project labels:** In this example, the organization is `samuelcolvin`, and the project is `logfire-demo-spider`. You can click the organization name to go to the organization overview page; the project name is a link to this page.

2. **Project pages:** These are links to the various project-specific pages, including the Live, [Dashboards](./02_dashboards.md), [Alerts](./03_alerts.md), [Explore](./04_explore.md), and Settings pages.
2. **Project pages:** These are links to the various project-specific pages, including the Live, [Dashboards](./dashboards.md), [Alerts](./alerts.md), [Explore](./explore.md), and Settings pages.

3. **Feedback and Beta buttons:** Click the feedback button to provide us feedback. The beta button has more information about Logfire's beta status.

Expand All @@ -22,7 +22,7 @@ This is what you'll see when you come to the live view of a project with some da

6. **Organization selection panel:** Opens a drawer with links to the different organizations you are a member of, and also has links to the Terms and Conditions, Support, Documentation, and a Log Out button.

7. **Query text input:** Enter a SQL query here to find spans that match the query. The query should be in the form of a Postgres-compatible `WHERE` clause on the records table (e.g. to find warnings, enter `level >= level_num('error')`). See the [Explore docs](./04_explore.md) for more detail about the schema here.
7. **Query text input:** Enter a SQL query here to find spans that match the query. The query should be in the form of a Postgres-compatible `WHERE` clause on the records table (e.g. to find warnings, enter `level >= level_num('error')`). See the [Explore docs](./explore.md) for more detail about the schema here.

8. **Search button:** You can click here to run the query after you've entered it, or just press cmd+enter (or ctrl+enter on windows/linux).

Expand Down
30 changes: 15 additions & 15 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -72,25 +72,25 @@ nav:
- First Steps: guides/first_steps/index.md
- Onboarding Checklist:
- Onboarding Checklist: guides/onboarding_checklist/index.md
- Create a Project: guides/onboarding_checklist/01_create_a_project.md
- Integrate Logfire: guides/onboarding_checklist/02_integrate.md
- Add Logfire Manual Tracing: guides/onboarding_checklist/03_add_manual_tracing.md
- Add Logfire Auto-Tracing: guides/onboarding_checklist/04_add_auto_tracing.md
- Add Logfire Metrics: guides/onboarding_checklist/05_add_metrics.md
- Create a Project: guides/onboarding_checklist/create_a_project.md
- Integrate Logfire: guides/onboarding_checklist/integrate.md
- Add Logfire Manual Tracing: guides/onboarding_checklist/add_manual_tracing.md
- Add Logfire Auto-Tracing: guides/onboarding_checklist/add_auto_tracing.md
- Add Logfire Metrics: guides/onboarding_checklist/add_metrics.md
- Web UI:
- Intro to the Web UI: guides/web_ui/index.md
- Live View: guides/web_ui/01_live.md
- Dashboards: guides/web_ui/02_dashboards.md
- Alerts: guides/web_ui/03_alerts.md
- SQL Explorer: guides/web_ui/04_explore.md
- Live View: guides/web_ui/live.md
- Dashboards: guides/web_ui/dashboards.md
- Alerts: guides/web_ui/alerts.md
- SQL Explorer: guides/web_ui/explore.md
- Advanced User Guide:
- Advanced User Guide: guides/advanced/index.md
- Sampling: guides/advanced/01_sampling.md
- Scrubbing: guides/advanced/02_scrubbing.md
- Testing: guides/advanced/03_testing.md
- Backfill: guides/advanced/04_backfill.md
- Creating Write Tokens: guides/advanced/05_creating_write_tokens.md
- Direct Database Connections: guides/advanced/06_direct_database_connections.md
- Sampling: guides/advanced/sampling.md
- Scrubbing: guides/advanced/scrubbing.md
- Testing: guides/advanced/testing.md
- Backfill: guides/advanced/backfill.md
- Creating Write Tokens: guides/advanced/creating_write_tokens.md
- Direct Database Connections: guides/advanced/direct_database_connections.md
- Integrations:
- Integrations: integrations/index.md
- OpenTelemetry:
Expand Down

0 comments on commit 25e031c

Please sign in to comment.