diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index adc7170..fc8a8a5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# Contributing to the Logfire JavaScript SDK - instructions +# Contributing to the Pydantic Logfire JavaScript SDK - instructions 1. Fork and clone the repository. 2. Run `npm install`. diff --git a/README.md b/README.md index 97aeafc..8855a2c 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,16 @@ # Pydantic Logfire — Uncomplicated Observability — JavaScript SDK -From the team behind [Pydantic](https://pydantic.dev/), **Logfire** is an -observability platform built on the same belief as our open source library — -that the most powerful tools can be easy to use. +From the team behind [Pydantic Validation](https://pydantic.dev/), **Pydantic Logfire** is an observability platform built on the same belief as our open source library — that the most powerful tools can be easy to use. What sets Logfire apart: -- **Simple and Powerful:** Logfire's dashboard is simple relative to the power - it provides, ensuring your entire engineering team will actually use it. -- **SQL:** Query your data using standard SQL — all the control and (for many) - nothing new to learn. Using SQL also means you can query your data with - existing BI tools and database querying libraries. -- **OpenTelemetry:** Logfire is an opinionated wrapper around OpenTelemetry, - allowing you to leverage existing tooling, infrastructure, and instrumentation - for many common packages, and enabling support for virtually any language. We - offer full support for all OpenTelemetry signals (traces, metrics, and logs). - -**Feel free to report issues and ask any questions about Logfire in this -repository!** - -This repository contains the JavaScript SDK for `logfire` and its documentation; -the server application for recording and displaying data is closed source. +- **Simple and Powerful:** Logfire's dashboard is simple relative to the power it provides, ensuring your entire engineering team will actually use it. +- **SQL:** Query your data using standard SQL — all the control and (for many) nothing new to learn. Using SQL also means you can query your data with existing BI tools and database querying libraries. +- **OpenTelemetry:** Logfire is an opinionated wrapper around OpenTelemetry, allowing you to leverage existing tooling, infrastructure, and instrumentation for many common packages, and enabling support for virtually any language. We offer full support for all OpenTelemetry signals (traces, metrics, and logs). + +**Feel free to report issues and ask any questions about Logfire in this repository!** + +This repository contains the JavaScript SDK for `logfire` and its documentation; the server application for recording and displaying data is closed source. Logfire UI with Next.js traces diff --git a/examples/nextjs-client-side-instrumentation/README.md b/examples/nextjs-client-side-instrumentation/README.md index 6ebdb77..9264322 100644 --- a/examples/nextjs-client-side-instrumentation/README.md +++ b/examples/nextjs-client-side-instrumentation/README.md @@ -1,7 +1,6 @@ -# Example for a Next.js client/server distributed OTel instrumentation with Logfire +# Example for a Next.js client/server distributed OTel instrumentation with Pydantic Logfire - -The example showcases how a fetch request initiated from the browser can propagate to the server and then to a third-party service, all while being instrumented with OpenTelemetry. The example uses the Logfire OTel SDK for both the client and server sides. +The example showcases how a fetch request initiated from the browser can propagate to the server and then to a third-party service, all while being instrumented with OpenTelemetry. The example uses the Pydantic Logfire OTel SDK for both the client and server sides. ## Highlights diff --git a/packages/logfire-api/README.md b/packages/logfire-api/README.md index c21849c..5423360 100644 --- a/packages/logfire-api/README.md +++ b/packages/logfire-api/README.md @@ -1,6 +1,5 @@ # Pydantic Logfire — Uncomplicated Observability — JavaScript SDK -From the team behind [Pydantic](https://pydantic.dev/), **Logfire** is an observability platform built on the same belief as our -open source library — that the most powerful tools can be easy to use. +From the team behind [Pydantic Validation](https://pydantic.dev/), **Pydantic Logfire** is an observability platform built on the same belief as our open source library — that the most powerful tools can be easy to use. Check the [Github Repository README](https://github.com/pydantic/logfire-js) for more information on how to use the SDK. diff --git a/packages/logfire-cf-workers/README.md b/packages/logfire-cf-workers/README.md index c21849c..5423360 100644 --- a/packages/logfire-cf-workers/README.md +++ b/packages/logfire-cf-workers/README.md @@ -1,6 +1,5 @@ # Pydantic Logfire — Uncomplicated Observability — JavaScript SDK -From the team behind [Pydantic](https://pydantic.dev/), **Logfire** is an observability platform built on the same belief as our -open source library — that the most powerful tools can be easy to use. +From the team behind [Pydantic Validation](https://pydantic.dev/), **Pydantic Logfire** is an observability platform built on the same belief as our open source library — that the most powerful tools can be easy to use. Check the [Github Repository README](https://github.com/pydantic/logfire-js) for more information on how to use the SDK. diff --git a/packages/logfire/README.md b/packages/logfire/README.md index c21849c..5423360 100644 --- a/packages/logfire/README.md +++ b/packages/logfire/README.md @@ -1,6 +1,5 @@ # Pydantic Logfire — Uncomplicated Observability — JavaScript SDK -From the team behind [Pydantic](https://pydantic.dev/), **Logfire** is an observability platform built on the same belief as our -open source library — that the most powerful tools can be easy to use. +From the team behind [Pydantic Validation](https://pydantic.dev/), **Pydantic Logfire** is an observability platform built on the same belief as our open source library — that the most powerful tools can be easy to use. Check the [Github Repository README](https://github.com/pydantic/logfire-js) for more information on how to use the SDK.