Add overviews, logoIds and missing ingest options (#96)

Co-authored-by: Mano Toth <[email protected]>
Co-authored-by: Mano Toth <[email protected]>

Author: dasfmi

README.md

@@ -66,4 +66,4 @@ We value your input and invite you to help us make the Axiom documentation even
 ## Troubleshooting
 
 - If the local build fails, run `mintlify install` to re-install dependencies.
-- If a page loads as a 404, make sure you run the local build in the root folder where the file `mint.json` is present.
+- If a page loads as a 404, make sure you run the local build in the root folder where the file `mint.json` is present.

apps/cloudflare-logpush.mdx

@@ -1,9 +1,13 @@
 ---
 title: 'Connect Axiom with Cloudflare Logpush'
 description: "Axiom gives you an all-at-once view of key Cloudflare Logpush metrics and logs, out of the box, with our dynamic Cloudflare Logpush dashboard."
+overview: 'Service for pushing logs to storage services in real-time'
 sidebarTitle: Cloudflare Logpush
 tags:
     ['axiom documentation', 'documentation', 'axiom', 'cloudflare logpush', 'requests', 'edge network', 'route trigger', 'cloudflare']
+logoId: 'cloudflare'
+isPopular: true
+popularityOrder: 6
 ---
 
 Cloudflare Logpush is a feature that allows you to push HTTP request logs and other Cloudflare-generated logs directly to your desired storage, analytics, and monitoring solutions like Axiom. The integration with Axiom aims to provide real-time insights into web traffic, and operational issues, thereby helping to monitor and troubleshoot effectively.
@@ -66,7 +70,7 @@ For account-scoped Logpush jobs:
 
 Using Axiom with Cloudflare Logpush offers a powerful solution for real-time monitoring, observability, and analytics. Axiom can help you gain deep insights into your app’s performance, errors, and app bottlenecks.
 
-### Benefits of using the Axiom Cloudflare Logpush Dashboard 
+### Benefits of using the Axiom Cloudflare Logpush Dashboard
 
 - Real-time visibility into web performance: One of the most crucial features is the ability to see how your website or app is performing in real-time. The dashboard can show everything from page load times to error rates, giving you immediate insights that can help in timely decision-making.
 
@@ -115,4 +119,4 @@ Account-scoped
 - Magic IDS Detections
 - Network Analytics Logs
 - Workers Trace Events
-- Zero Trust Network Session Logs
+- Zero Trust Network Session Logs

apps/cloudflare-workers.mdx

@@ -14,7 +14,7 @@ The data obtained with the Axiom dashboard gives you better insights into the st
 
 Cloudflare Workers is a serverless computing platform developed by Cloudflare. The Workers platform allows developers to deploy and run JavaScript code directly at the network edge in more than 200 data centers worldwide. This serverless architecture enables high performance, low latency, and efficient scaling for web apps and APIs.
 
-## Sending Cloudflare Worker logs to Axiom 
+## Sending Cloudflare Worker logs to Axiom
 
 The Axiom Cloudflare worker repository plugin is available on [GitHub](https://github.com/axiomhq/axiom-cloudflare-workers).
 
@@ -65,4 +65,4 @@ When requests are made to the routes you set up, the worker will be triggered, a
 
 <Frame caption="Cloudflare datasets">
   <img src="/doc-assets/shots/cloudflare-datasets-logs.png" alt="Cloudflare datasets" />
-</Frame>
+</Frame>

apps/netlify.mdx

@@ -1,9 +1,11 @@
 ---
 title: 'Connect Axiom with Netlify'
 description: 'Integrating Axiom with Netlify to get a comprehensive observability experience for your Netlify projects. This app will give you a better understanding of how your Jamstack apps are performing.'
+overview: 'All-in-one platform for automating modern web projects'
 sidebarTitle: Netlify
 tags:
     ['axiom documentation', 'documentation', 'axiom', 'netlify', log drains', 'jamstack', 'zero config observability']
+logoId: 'netlify'
 ---
 
 Integrate Axiom with Netlify to get a comprehensive observability experience for your Netlify projects. This integration will give you a better understanding of how your Jamstack apps are performing.
@@ -16,13 +18,13 @@ Axiom’s Netlify app is complete with a pre-built dashboard that gives you cont
 
 Overall, the Axiom Netlify app makes it easy to monitor and optimize your Jamstack apps. However, do note that this integration is only available for Netlify customers enterprise-level plans where [Log Drains are supported](https://docs.netlify.com/monitor-sites/log-drains/).
 
-## What is Netlify 
+## What is Netlify
 
 Netlify is a platform for building highly-performant and dynamic websites, e-commerce stores, and web apps. Netlify automatically builds your site and deploys it across its global edge network.
 
 The Netlify platform provides teams everything they need to take modern web projects from the first preview to full production.
 
-## Sending logs to Axiom 
+## Sending logs to Axiom
 
 The log events gotten from Axiom gives you better insight into the state of your Netlify sites environment so that you can easily monitor traffic volume, website configurations, function logs, resource usage, and more.
 

apps/tailscale.mdx

@@ -1,9 +1,11 @@
 ---
 title: 'Connect Axiom with Tailscale'
 description: 'This page explains how to integrate Axiom with Tailscale.'
+overview: 'Zero config VPN for building secure networks'
 sidebarTitle: Tailscale
 tags:
     ['axiom documentation', 'documentation', 'axiom', 'guide', 'logs', 'tailscale']
+logoId: 'tailscale'
 ---
 
 import Prerequisites from "/snippets/standard-prerequisites.mdx"
@@ -39,4 +41,4 @@ With these insights, you can:
 - Track configuration changes and user actions.
 - Monitor overall network health and performance.
 - Investigate specific events or users as needed.
-- Understand traffic distribution across your tailnet.
+- Understand traffic distribution across your tailnet.

apps/vercel.mdx

@@ -1,9 +1,12 @@
 ---
 title: 'Connect Axiom with Vercel'
 description: 'Easily monitor data from requests, functions, and web vitals in one place to get the deepest observability experience for your Vercel projects.'
+overview: 'Platform for frontend frameworks and static sites'
 sidebarTitle: Vercel
 tags:
   ['axiom documentation', 'documentation', 'axiom', 'vercel', 'request logs', 'function logs', 'web vitals', 'vercel app', 'vercel app']
+logoId: 'vercel'
+darkLogoId: 'vercelDark'
 ---
 
 Connect Axiom with Vercel to get the deepest observability experience for your Vercel projects.
@@ -88,7 +91,7 @@ WebVitals are sent only from production deployments.
 log.info('Payment completed', { userID: '123', amount: '25USD' });
 ```
 
-### Client Components 
+### Client Components
 
 For Client Components, replace the `log` prop usage with the `useLogger` hook:
 
@@ -103,7 +106,7 @@ export default function ClientComponent() {
 }
 ```
 
-### Server Components 
+### Server Components
 
 For Server Components, create a logger and make sure to call flush before returning:
 
@@ -159,7 +162,7 @@ If you plan on upgrading to Next.js 13, you'll need to make specific changes to
 - For server-side components, you need to create an instance of the `Logger` and flush the logs before the component returns.
 - For Web Vitals tracking, you'll replace the previous method of capturing data. Remove the `reportWebVitals()` line and instead integrate the `AxiomWebVitals` component into your layout.
 
-## Vercel Function logs 4KB limit 
+## Vercel Function logs 4KB limit
 
 The Vercel 4KB log limit refers to a restriction placed by Vercel on the size of log output generated by serverless functions running on their platform. The 4KB log limit means that each log entry produced by your function should be at most 4 Kilobytes in size.
 
@@ -197,7 +200,7 @@ If you use a logging library in your Vercel project that prints JSON, your **mes
 }
 ```
 
-- The **JSON** data in your **message** would be: 
+- The **JSON** data in your **message** would be:
 
 ```json
 {
@@ -211,7 +214,7 @@ If you use a logging library in your Vercel project that prints JSON, your **mes
 
 You can **parse** the JSON using the [parse_json function](/apl/scalar-functions/string-functions#parse-json()) and run queries against the **values** in the **message** field.
 
-### Example 
+### Example
 
 ```kusto
 ['vercel']
@@ -266,4 +269,4 @@ For more configuration options, see the [documentation in the next-axiom GitHub
 
 ## Send logs from Vercel preview deployments
 
-To send logs from Vercel preview deployments to Axiom, enable preview deployments for the environment variable `NEXT_PUBLIC_AXIOM_INGEST_ENDPOINT`. For more information, see the [Vercel documentation](https://vercel.com/docs/projects/environment-variables/managing-environment-variables).
+To send logs from Vercel preview deployments to Axiom, enable preview deployments for the environment variable `NEXT_PUBLIC_AXIOM_INGEST_ENDPOINT`. For more information, see the [Vercel documentation](https://vercel.com/docs/projects/environment-variables/managing-environment-variables).

endpoints/honeycomb.mdx

@@ -1,8 +1,10 @@
 ---
 title: 'Send data from Honeycomb to Axiom'
 description: "Integrate Axiom in your existing Honeycomb stack with minimal effort and without breaking any of your existing Honeycomb workflows."
+overview: 'Observability tool for debugging and understanding distributed systems'
 sidebarTitle: Honeycomb
 tags: ['axiom documentation', 'documentation', 'axiom', 'endpoints', 'http', 'syslog', 'splunk', 'datadog', 'loki', 'honeycomb']
+logoId: 'honeycomb'
 ---
 
 import SetUpEndpoint from "/snippets/set-up-endpoint.mdx"

endpoints/loki.mdx

@@ -1,9 +1,11 @@
 ---
 title: 'Send data from Loki to Axiom'
 description: 'Integrate Axiom in your existing Loki stack with minimal effort and without breaking any of your existing Loki workflows.'
+overview: 'Horizontally-scalable, multi-tenant log aggregation system'
 sidebarTitle: Loki
-tags:   
+tags:
   ['axiom documentation', 'documentation', 'axiom', 'endpoints', 'http', 'syslog', 'splunk', 'datadog', 'loki', 'honeycomb', 'javascript', 'python']
+logoId: 'grafanaLoki'
 ---
 
 import SetUpEndpoint from "/snippets/set-up-endpoint.mdx"
@@ -81,4 +83,4 @@ logger.addHandler(handler)
 logger.info('Hello, world from Python!')
 logger.warning('This is a warning')
 logger.error('This is an error')
-```
+```

endpoints/splunk.mdx

@@ -1,8 +1,10 @@
 ---
 title: 'Send data from Splunk to Axiom'
 description: 'Integrate Axiom in your existing Splunk app with minimal effort and without breaking any of your existing Splunk stack.'
+overview: 'Platform for searching, monitoring, and analyzing machine-generated data'
 sidebarTitle: Splunk
 tags: ['axiom documentation', 'documentation', 'axiom', 'endpoints', 'http', 'syslog', 'splunk', 'datadog', 'loki', 'honeycomb', 'javascript', 'python']
+logoId: 'splunk'
 ---
 
 import SetUpEndpoint from "/snippets/set-up-endpoint.mdx"

guides/apex.mdx

@@ -0,0 +1,9 @@
+---
+title: 'Axiom Go Adapter for apex/log'
+description: 'Adapter to ship logs generated by apex/log to Axiom.'
+overview: 'Minimalistic logging library for Go'
+sidebarTitle: 'Apex'
+url: 'https://pkg.go.dev/github.com/axiomhq/axiom-go/adapters/apex'
+tags: ['go', 'golang', 'apex']
+logoId: 'apex'
+---

guides/go.mdx

@@ -1,7 +1,12 @@
 ---
 title: 'Send data from Go app to Axiom'
 description: 'This page explains how to send data from a Go app to Axiom.'
+overview: 'Open-source programming language designed for simplicity and efficiency'
 sidebarTitle: Golang
+github: "https://github.com/axiomhq/axiom-go"
+tags: ['go', 'golang']
+logoId: 'golang'
+enlargeLogo: true
 ---
 
 To send data from a Go app to Axiom, use the Axiom Go SDK.
@@ -90,4 +95,4 @@ For more examples, see the [examples in GitHub](https://github.com/axiomhq/axiom
 
 ## Adapters
 
-To use a logging package, see the [adapters in GitHub](https://github.com/axiomhq/axiom-go/tree/main/adapters).
+To use a logging package, see the [adapters in GitHub](https://github.com/axiomhq/axiom-go/tree/main/adapters).

guides/javascript.mdx

@@ -1,7 +1,13 @@
 ---
 title: 'Send data from JavaScript app to Axiom'
 description: 'This page explains how to send data from a JavaScript app to Axiom.'
+overview: 'High-level, interpreted programming language for web development'
 sidebarTitle: JavaScript
+github: "https://github.com/axiomhq/axiom-js"
+tags: ['js', 'javascript', 'node', 'typescript', 'ts', 'node.js']
+logoId: 'javascript'
+isPopular: true
+popularityOrder: 8
 ---
 
 To send data from a JavaScript app to Axiom, use the Axiom JavaScript SDK.
@@ -94,4 +100,4 @@ await annotations.create({
 While the Axiom JavaScript client works on both the backend and the browsers, Axiom provides transports for some of the popular loggers:
 
 - [Pino](/guides/pino)
-- [Winston](/guides/winston)
+- [Winston](/guides/winston)

guides/logrus.mdx

@@ -0,0 +1,9 @@
+---
+title: 'Axiom Go Adapter for sirupsen/logrus'
+description: 'Adapter to ship logs generated by sirupsen/logrus to Axiom.'
+overview: 'Structured logger for Go'
+sidebarTitle: 'Logrus'
+url: 'https://pkg.go.dev/github.com/axiomhq/axiom-go/adapters/logrus'
+tags: ['go', 'golang', 'logrus']
+logoId: 'logrus'
+---

guides/opentelemetry-cloudflare-workers.mdx

@@ -1,12 +1,13 @@
 ---
 title: 'OpenTelemetry using Cloudflare Workers'
 description: 'This guide explains how to configure a Cloudflare Workers app to send telemetry data to Axiom.'
+overview: 'Serverless execution environment at the edge'
 sidebarTitle: Cloudflare Workers
-tags:
-    ['guides', 'cloudflare worker']
+tags: ['guides', 'cloudflare worker', 'otel', 'opentelemetry']
+logoId: 'cloudflareWorkers'
 ---
 
-This guide demonstrates how to configure OpenTelemetry in Cloudflare Workers to send telemetry data to Axiom using the [OTel CF Worker package](https://github.com/evanderkoogh/otel-cf-workers).  
+This guide demonstrates how to configure OpenTelemetry in Cloudflare Workers to send telemetry data to Axiom using the [OTel CF Worker package](https://github.com/evanderkoogh/otel-cf-workers).
 
 ## Prerequisites
 
@@ -24,15 +25,15 @@ Create a new directory for your project and navigate into it:
 mkdir my-axiom-worker && cd my-axiom-worker
 ```
 
-Initialize a new Wrangler project using this command: 
+Initialize a new Wrangler project using this command:
 
 ```bash
 wrangler init --type="javascript"
 ```
 
 ## Cloudflare Workers Script Configuration (index.ts)
 
-Configure and implement your Workers script by integrating OpenTelemetry with the `@microlabs/otel-cf-workers` package to send telemetry data to Axiom, as illustrated in the example `index.ts` below: 
+Configure and implement your Workers script by integrating OpenTelemetry with the `@microlabs/otel-cf-workers` package to send telemetry data to Axiom, as illustrated in the example `index.ts` below:
 
 ```js
 // index.ts
@@ -138,7 +139,7 @@ To run your Cloudflare Workers app with OpenTelemetry instrumentation, ensure yo
 
 ### In development mode
 
-For local development and testing, you can start a local development server by running: 
+For local development and testing, you can start a local development server by running:
 
 ```bash
 npm run start
@@ -148,7 +149,7 @@ This command runs `wrangler dev` allowing you to preview and test your app local
 
 ### Deploying to production
 
-Deploy your app to the Cloudflare Workers environment by running: 
+Deploy your app to the Cloudflare Workers environment by running:
 
 ```bash
 npm run deploy
@@ -251,10 +252,10 @@ Wrap your Cloudflare Workers script with the `instrument` function from the **`@
 
 ```js
 import { instrument } from '@microlabs/otel-cf-workers';
-    
+
 export default instrument(yourHandler, yourConfig);
 ```
-    
+
 2. Configuration: Provide configuration details, including how to export telemetry data and service metadata to Axiom as part of the `instrument` function call.
 
 ```js
@@ -367,4 +368,4 @@ These packages provide the foundational elements for OTLP exporters, including t
 
 **`@opentelemetry/resources`**
 
-Defines the Resource, which represents the entity producing telemetry. In Cloudflare Workers, Resources can be used to describe the worker (for example,, service name, version) and are attached to all exported telemetry, aiding in identifying data in backend systems.
+Defines the Resource, which represents the entity producing telemetry. In Cloudflare Workers, Resources can be used to describe the worker (for example,, service name, version) and are attached to all exported telemetry, aiding in identifying data in backend systems.

guides/opentelemetry-django.mdx

@@ -1,9 +1,10 @@
 ---
 title: 'Send OpenTelemetry data from a Django app to Axiom'
 description: 'This guide explains how to send OpenTelemetry data from a Django app to Axiom using the Python OpenTelemetry SDK.'
+overview: 'Django framework with OpenTelemetry integration'
 sidebarTitle: Django Using OTel
-tags:
-    ['guides', 'django']
+tags: ['guides', 'django', 'otel', 'opentelemetry', 'python']
+logoId: 'openTelemetry'
 ---
 
 import Prerequisites from "/snippets/standard-prerequisites.mdx"
@@ -73,7 +74,7 @@ from opentelemetry.instrumentation.django import DjangoInstrumentor
 def main():
     """Run administrative tasks."""
     os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'your_project_name.settings')
-    
+
     # Initialize OpenTelemetry instrumentation
     DjangoInstrumentor().instrument()
 
@@ -443,4 +444,4 @@ This import brings in the tracer instance defined in `exporter.py`, which is use
 
 ```py
 from .exporter import tracer
-```
+```