- The starting point of every pipeline. Choose which dataset to read from
- and which field to pull out of it.
-
-
-
- Adapter: the data provider or dataset (for example,
- Events or Sessions). This determines which fields you can pick below.
-
-
- Field: the metric or property to read from the selected
- adapter.
-
-
- Dedupe: when checked, counts only the latest row per
- identity (where the data source supports it). Useful for unique-visitor
- style queries.
-
-
-
-
-
-
-
-
----
-
-### Filter
-
-
-
-
- Keeps rows that match a condition and drops the rest. Pick a field, an
- operator, and a comparison value. Only matching rows continue down the
- pipeline.
-
-
-
- Field: which upstream field to compare.
-
-
- Operator: how to compare. Available options:{" "}
- equals, not equals, contains,{" "}
- matches regex, does not match regex,{" "}
- greater than, less than,{" "}
- greater or equal, less or equal.
-
-
- Value: what to compare against. Becomes a true/false
- dropdown when filtering a boolean field.
-
-
- Map target: only shown for map fields. Choose whether
- to filter on the map's keys or its values.
-
-
-
-
-
-
-
-
----
-
-### Aggregate
-
-
-
-
- Reduces multiple rows into one computed value per group. Usually placed
- after a Group By or Time Group node.
-
-
-
- Function: how values inside each group are combined:
-
-
- count: number of rows in the group
-
-
- sum: adds numeric values
-
-
- avg: average of numeric values
-
-
- min: smallest numeric value
-
-
- max: largest numeric value
-
-
- distinct: count of unique values
-
-
-
-
-
-
-
-
-
-
----
-
-### Group By
-
-
-
-
- Groups rows by one or more categorical fields. Usually paired with an{" "}
- Aggregate node to compute per-group metrics (for example,
- page views grouped by browser).
-
-
-
- Fields: the grouping dimensions. Rows that share the
- same values across these fields end up in the same group. Add as many as
- you need.
-
-
- Multi-field mode: only shown when more than one field
- is selected.
-
-
- combined: joins field values into a single composite
- key (for example, Chrome / Germany as one group).
-
-
- flat: keeps each field as its own dimension so the
- chart can break down by either axis.
-
-
-
-
-
-
-
-
-
-
----
-
-### Time Group
-
-
-
-
- Groups rows into time-based buckets. This is the foundation of every
- time-series chart.
-
-
-
- Bucket size: the interval each row rolls into:{" "}
- Auto, Minute, Hour,{" "}
- Day, Week, Month.{" "}
- Auto picks a sensible size based on the chart's time range.
-
-
- Missing buckets: what to do when a time period has no
- data:
-
-
- Zero: insert a zero value so the line stays continuous.
-
-
- None: leave the gap empty and the series breaks.
-
-
-
-
- Cumulative: carry each bucket's value into every later
- bucket. Use this for running totals, such as total users or downloads so
- far.
-
-
-
-
-
-
-
-
----
-
-### Text Transform
-
-
-
-
- Rewrites string values before they are grouped, filtered, or displayed.
- Useful for normalizing inconsistent text (for example, casing) or
- extracting derived labels.
-
- append: add a fixed string to the end of each value
-
-
- replace text: find an exact string and replace it
-
-
- replace regex: match a regular expression and
- substitute (use \1, \2, and so on for
- capture groups)
-
-
- length: replace each value with its character count
-
-
-
-
- Text to append: only for append. The
- string added to every value.
-
-
- Find / Pattern and Replace with: only
- for replace text and replace regex. Leave the
- replacement empty to delete matches.
-
-
-
-
-
-
-
-
----
-
-### Formula
-
-
-
-
- Computes a derived numeric value from a custom expression. Each input
- connection to the Formula node gets a letter (A,{" "}
- B, C, and so on) in the order it was connected.
- Use those letters as variables in the expression.
-
-
-
- Expression: the formula to evaluate, for example{" "}
- A + B, A / B * 100, or{" "}
- (A + B) / C.
-
-
- Output name: name of the resulting field. Downstream
- nodes and the chart legend use this label.
-
-
- Precision: number of decimal places to round the result
- to. Leave empty to keep full precision.
-
-
-
-
-
-
-
-
----
-
-### Limit
-
-
-
-
- Caps the number of rows that flow through. Most useful after a{" "}
- Group By when you only want the top N groups in a chart.
-
-
-
- Max rows: the maximum number of rows to keep.
-
-
- Group rows over limit as Other: instead of dropping
- rows beyond the limit, fold them into a single Other bucket
- so totals still match.
-
-
-
-
-
-
-
-
----
-
-### Max Age
-
-
-
-
- Limits the pipeline to events within a rolling window relative to now.
- Combine with Min Age to look at a slice between two
- points in the past.
-
-
-
- Look back at most: the size of the window. Pick a
- number and a unit: ms, seconds,{" "}
- minutes, hours, days.
-
-
-
-
-
-
-
-
----
-
-### Min Age
-
-
-
-
- Drops events that are too recent. Useful for excluding the live tail of
- data that has not fully settled yet, or for comparing past periods.
-
-
-
- Exclude newer than: events within this window before
- the current time are removed. Uses the same units as{" "}
- Max Age.
-
-
-
-
-
-
-
-
----
-
-### Output
-
-
-
-
- The final node in every pipeline. This is what produces the chart result.
- See{" "}
- Output & Multi-Series{" "}
- for how multiple Output nodes combine into tabs, multi-line charts, or
- stacked bars.
-
-
-
- Output name (or Tab name on list
- charts): label shown in the chart legend or as the tab header.
-
-
- Icon set: only on list charts. Optional icons shown
- next to each row.
-
-
- Nest by: only on list and pie charts. Splits each row
- into a nested hierarchy, either by another data field or by a custom
- delimiter.
-
-
- Delimiter: only when nesting by a custom pattern. The
- character or string used to split values (for example, / to
- split a URL path).
-
+
+
diff --git a/src/components/starlight/topics/TopicsSelector.astro b/src/components/starlight/topics/TopicsSelector.astro
new file mode 100644
index 0000000..ecb3233
--- /dev/null
+++ b/src/components/starlight/topics/TopicsSelector.astro
@@ -0,0 +1,8 @@
+---
+import Topics from './Topics.astro';
+
+const { hasSidebar } = Astro.locals.starlightRoute;
+const { isPageWithTopic } = Astro.locals.starlightSidebarTopics;
+---
+
+{hasSidebar && isPageWithTopic && }
diff --git a/src/content.config.ts b/src/content.config.ts
new file mode 100644
index 0000000..469fdc3
--- /dev/null
+++ b/src/content.config.ts
@@ -0,0 +1,16 @@
+import { defineCollection } from 'astro:content';
+import { docsLoader } from '@astrojs/starlight/loaders';
+import { docsSchema } from '@astrojs/starlight/schema';
+import { topicSchema } from 'starlight-sidebar-topics/schema';
+import { z } from 'astro/zod';
+
+export const collections = {
+ docs: defineCollection({
+ loader: docsLoader(),
+ schema: docsSchema({
+ extend: topicSchema.extend({
+ icon: z.string().optional(),
+ }),
+ }),
+ }),
+};
diff --git a/src/content.ts b/src/content.ts
new file mode 100644
index 0000000..4e2d861
--- /dev/null
+++ b/src/content.ts
@@ -0,0 +1,14 @@
+import { getCollection, type CollectionEntry } from "astro:content";
+
+export const allPages = await getCollection('docs');
+
+/** Paths for all of our Markdown content we want to generate OG images for. */
+const paths = process.env.SKIP_OG ? [] : allPages;
+
+/** An object mapping file paths to file metadata. */
+export const pages = Object.fromEntries(
+ paths.map(
+ ({ filePath, id, data }) =>
+ [filePath, { data, id }] as [string, Pick, 'data' | 'id'>]
+ )
+);
\ No newline at end of file
diff --git a/content/docs/api/index.mdx b/src/content/docs/api/index.mdx
similarity index 57%
rename from content/docs/api/index.mdx
rename to src/content/docs/api/index.mdx
index c672b60..c58033f 100644
--- a/content/docs/api/index.mdx
+++ b/src/content/docs/api/index.mdx
@@ -4,16 +4,21 @@ description: FastStats REST API reference
icon: BookOpen
---
+import ReadMore from '@/components/ReadMore.astro';
+import { Aside } from "@astrojs/starlight/components"
+
Use the FastStats REST API to manage projects, dashboards, charts, and analytics data programmatically.
Create an API key in your user or organization settings.
-
+
+
-
+
+
-The OpenAPI spec is available at [api.faststats.dev/openapi.json](https://api.faststats.dev/openapi.json).
+
+ The OpenAPI spec is available at [api.faststats.dev/openapi.json](https://api.faststats.dev/openapi.json).
+
diff --git a/content/docs/java/configuration.mdx b/src/content/docs/java/configuration.mdx
similarity index 88%
rename from content/docs/java/configuration.mdx
rename to src/content/docs/java/configuration.mdx
index 446773a..0b07db2 100644
--- a/content/docs/java/configuration.mdx
+++ b/src/content/docs/java/configuration.mdx
@@ -4,6 +4,8 @@ description: Advanced configuration options for FastStats Java SDK
icon: Settings
---
+import ReadMore from '@/components/ReadMore.astro';
+
Configure FastStats by creating a platform context and attaching the services
your project uses.
@@ -11,7 +13,7 @@ your project uses.
The minimal metrics configuration requires only a token:
-```java
+```java title='ExamplePlugin.java'
import dev.faststats.Metrics;
import dev.faststats.bukkit.BukkitContext;
@@ -29,7 +31,7 @@ public void onEnable() {
Here's a configured Bukkit context with error tracking, custom metrics, and a
flush callback:
-```java
+```java title='ExamplePlugin.java'
import dev.faststats.ErrorTracker;
import dev.faststats.bukkit.BukkitContext;
import dev.faststats.data.Metric;
@@ -68,7 +70,9 @@ Metrics submission and error tracking start after `context.ready()` is called.
Call `context.ready()` from the platform startup hook, and call
`context.shutdown()` during shutdown.
-For error tracking configuration, see [Error Tracking](/java/error-tracking). For platform-specific setup, see the platform pages in the sidebar.
+
+ For error tracking configuration, see [Error Tracking](/java/error-tracking). For platform-specific setup, see the platform pages in the sidebar.
+
## Best Practices
diff --git a/content/docs/java/custom-metrics.mdx b/src/content/docs/java/custom-metrics.mdx
similarity index 98%
rename from content/docs/java/custom-metrics.mdx
rename to src/content/docs/java/custom-metrics.mdx
index 1ecbfc2..ae0ab8e 100644
--- a/content/docs/java/custom-metrics.mdx
+++ b/src/content/docs/java/custom-metrics.mdx
@@ -12,7 +12,7 @@ FastStats project settings.
Attach custom metrics when you create the platform context:
-```java
+```java title='ExamplePlugin.java'
import dev.faststats.bukkit.BukkitContext;
import dev.faststats.data.Metric;
@@ -134,7 +134,7 @@ without a successful submission.
If you do not need custom metrics, create the metrics service without adding any
metrics:
-```java
+```java title='ExamplePlugin.java'
import dev.faststats.Metrics;
private final BukkitContext context = new BukkitContext.Factory(this, "YOUR_TOKEN")
diff --git a/content/docs/java/error-tracking.mdx b/src/content/docs/java/error-tracking.mdx
similarity index 96%
rename from content/docs/java/error-tracking.mdx
rename to src/content/docs/java/error-tracking.mdx
index 4447df6..73f6581 100644
--- a/content/docs/java/error-tracking.mdx
+++ b/src/content/docs/java/error-tracking.mdx
@@ -4,24 +4,26 @@ description: Monitor and report errors from your Minecraft server plugin
icon: Bug
---
+import { Aside } from '@astrojs/starlight/components';
+
FastStats can automatically track errors in your project.
-
+
+
-
+
+
## Context-Aware Error Tracker
The context-aware error tracker automatically tracks uncaught errors from the
same class loader:
-```java
+```java title='MyBukkitPlugin.java'
import dev.faststats.ErrorTracker;
import dev.faststats.bukkit.BukkitContext;
import org.bukkit.plugin.java.JavaPlugin;
@@ -54,16 +56,16 @@ public final class MyBukkitPlugin extends JavaPlugin {
}
```
-
+
+
## Context-Unaware Error Tracker
The context-unaware error tracker only tracks errors passed to `trackError()`:
-```java
+```java title='MyBukkitPlugin.java'
import dev.faststats.ErrorTracker;
import dev.faststats.bukkit.BukkitContext;
import org.bukkit.plugin.java.JavaPlugin;
diff --git a/content/docs/java/feature-flags.mdx b/src/content/docs/java/feature-flags.mdx
similarity index 90%
rename from content/docs/java/feature-flags.mdx
rename to src/content/docs/java/feature-flags.mdx
index 1628b5e..5fb5230 100644
--- a/content/docs/java/feature-flags.mdx
+++ b/src/content/docs/java/feature-flags.mdx
@@ -4,17 +4,20 @@ description: Evaluate FastStats feature flags from Java projects
icon: Flag
---
-
+import ReadMore from '@/components/ReadMore.astro';
+import { Aside } from '@astrojs/starlight/components';
+
+
+
Feature flags are configured on a FastStats context. A context may enable
metrics, error tracking, feature flags, or any combination of those services.
## Configure a Service
-```java
+```java title='ExamplePlugin.java'
import dev.faststats.Attributes;
import dev.faststats.FastStatsContext;
import dev.faststats.FeatureFlagService;
@@ -106,4 +109,6 @@ newCommands.optOut();
Opt-in and opt-out invalidate the local value and fetch the current server value
again.
-For platform concepts and dashboard setup, see [Feature Flags](/platform/feature-flags).
+
+ For platform concepts and dashboard setup, see [Feature Flags](/platform/feature-flags).
+
diff --git a/content/docs/java/index.mdx b/src/content/docs/java/index.mdx
similarity index 50%
rename from content/docs/java/index.mdx
rename to src/content/docs/java/index.mdx
index bca83b1..8f455e3 100644
--- a/content/docs/java/index.mdx
+++ b/src/content/docs/java/index.mdx
@@ -4,45 +4,50 @@ description: Add FastStats to your Minecraft server project
icon: Download
---
-import { DynamicCodeBlock } from "fumadocs-ui/components/dynamic-codeblock";
-import { latestVersion } from "@/lib/docs/repository";
+import { Tabs, TabItem, Code } from '@astrojs/starlight/components';
+import { latestVersion } from "@/util/repository";
export const version = await latestVersion("core");
Add the FastStats SDK to your project using Maven or Gradle.
-
-
- ```xml
+
+
+
+ ```xml title='pom.xml'
faststats-releasesFastStatshttps://repo.faststats.dev/releases
```
-
-
- ```kts
+
+
+
+ ```kts title='build.gradle.kts'
maven {
name = "faststatsReleases"
url = uri("https://repo.faststats.dev/releases")
}
```
-
-
- ```groovy
+
+
+
+ ```groovy title='build.gradle'
maven {
name "faststatsReleases"
url "https://repo.faststats.dev/releases"
}
```
-
-
- ```scala
+
+
+
+ ```scala title='build.sbt'
resolvers +=
"faststats-releases"
at "https://repo.faststats.dev/releases"
```
-
+
+
## Platform-Specific Artifacts
@@ -53,63 +58,67 @@ Choose the artifact for your platform:
| -------------------------- | ----------------------------------------- | ------------- |
| Bukkit/Spigot/Paper/Folia⦠| [`bukkit`](/java/platform/bukkit) | 17+ |
| BungeeCord | [`bungeecord`](/java/platform/bungeecord) | 17+ |
-| Fabric | [`fabric`](/java/platform/fabric) | 25+ |
+| Fabric | [`fabric`](/java/platform/fabric) | 21+ |
| Hytale | [`hytale`](/java/platform/hytale) | 25+ |
| Minestom | [`minestom`](/java/platform/minestom) | 25+ |
-| NeoForge | [`neoforge`](/java/platform/neoforge) | 25+ |
+| NeoForge | [`neoforge`](/java/platform/neoforge) | 21+ |
| Nukkit | [`nukkit`](/java/platform/nukkit) | 17+ |
| Sponge | [`sponge`](/java/platform/sponge) | 17+ |
| Velocity | [`velocity`](/java/platform/velocity) | 21+ |
-
-
-
+Fabric and NeoForge artifacts include the SDK version and the Minecraft version range you want to target:
+
+```kts
+implementation("dev.faststats.metrics:fabric:0.27.2+mc26.1-26.3")
+implementation("dev.faststats.metrics:neoforge:0.27.2+mc26.1-26.2")
+```
+
+The version format is `{sdk-version}+mc{from}-{to}`, where `{sdk-version}` is
+the FastStats SDK version and `{from}-{to}` is the supported Minecraft version
+range for that artifact.
+
+You can find the available versions in the Maven repository:
+[Fabric](https://repo.faststats.dev/#/releases/dev/faststats/metrics/fabric/) and
+[NeoForge](https://repo.faststats.dev/#/releases/dev/faststats/metrics/neoforge/).
+
+All other platforms use the SDK version without a Minecraft version suffix.
+
+
+
+
+ dev.faststats.metricsbukkit${version}
-`}
- />
-
-
-
-
-
-
-
-
-
-
+`} />
+
+
+
+
+
+
+
+
+
+
+
+
+
+
## Shading
To include FastStats directly in your plugin JAR, you can use the Maven Shade or Gradle Shadow Plugin.
-
-
-
-
+
+
+
+
+
+ ```xml title='pom.xml'
+
+ org.apache.maven.pluginsmaven-shade-plugin
@@ -131,34 +140,33 @@ To include FastStats directly in your plugin JAR, you can use the Maven Shade or
-
-`}
- />
-
-
-
-
-
-
-
-
-
-
+
+
+ ```
+
+
+
+ ```kts title='build.gradle.kts'
+ plugins {
+ id("com.gradleup.shadow") version "9.4.1"
+ }
+
+ tasks.shadowJar {
+ relocate("dev.faststats", "your.plugin.libs.faststats") // optionally relocate the package
+ }
+ ```
+
+
+
+ ```groovy title='build.gradle'
+ plugins {
+ id 'com.gradleup.shadow' version '9.4.1'
+ }
+
+ tasks.named('shadowJar', com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar) {
+ relocate('dev.faststats', 'your.plugin.libs.faststats') // optionally relocate the package
+ }
+ ```
+
+
+
\ No newline at end of file
diff --git a/content/docs/java/migration.mdx b/src/content/docs/java/migration.mdx
similarity index 100%
rename from content/docs/java/migration.mdx
rename to src/content/docs/java/migration.mdx
diff --git a/content/docs/java/obfuscation-mappings.mdx b/src/content/docs/java/obfuscation-mappings.mdx
similarity index 89%
rename from content/docs/java/obfuscation-mappings.mdx
rename to src/content/docs/java/obfuscation-mappings.mdx
index 755131c..ed4fb63 100644
--- a/content/docs/java/obfuscation-mappings.mdx
+++ b/src/content/docs/java/obfuscation-mappings.mdx
@@ -4,32 +4,29 @@ description: Upload ProGuard/R8 obfuscation mapping files for stack traces deobf
icon: FileKey
---
-import { Callout } from "fumadocs-ui/components/callout";
+import { Tabs, TabItem, Aside } from '@astrojs/starlight/components';
FastStats resolves obfuscated Java stack traces using uploaded ProGuard/R8 mapping files.
The recommended workflow is the `dev.faststats.proguard-mappings-upload` Gradle plugin.
## Installation
-
-
-
- ```kotlin
- plugins {
+
+
+ ```kotlin title='build.gradle.kts'
+ plugins {
id("dev.faststats.proguard-mappings-upload") version "0.1.0"
}
- ```
-
-
-
+ ```
+
- ```groovy
- plugins {
+
+ ```groovy title='build.gradle'
+ plugins {
id 'dev.faststats.proguard-mappings-upload' version '0.1.0'
}
- ```
-
-
+ ```
+
@@ -61,22 +58,22 @@ mappingsUpload {
Setting `proguardTask` ensures the upload task runs after ProGuard finishes. `mappingFiles` must match the location
configured in your `printmapping` setting.
-
+
+
## Upload Authentication
Generate an API key in your FastStats project settings. The plugin accepts it via the `authToken` option
or the `FASTSTATS_AUTH_TOKEN` environment variable.
-
+
+
## All Options
@@ -106,7 +103,7 @@ Or chain it after your obfuscation task:
### GitHub Actions
-```yaml
+```yaml title='github-actions.yml'
name: Build & Upload Mappings
on:
@@ -132,7 +129,7 @@ jobs:
### GitLab CI
-```yaml
+```yaml title='gitlab-ci.yml'
build:
stage: build
script:
diff --git a/content/docs/java/platform/bukkit.mdx b/src/content/docs/java/platform/bukkit.mdx
similarity index 62%
rename from content/docs/java/platform/bukkit.mdx
rename to src/content/docs/java/platform/bukkit.mdx
index 2739eea..13cde56 100644
--- a/content/docs/java/platform/bukkit.mdx
+++ b/src/content/docs/java/platform/bukkit.mdx
@@ -4,11 +4,13 @@ description: Integrate FastStats with any Bukkit-based plugins
icon: Box
---
+import ReadMore from '@/components/ReadMore.astro';
+
Use `dev.faststats.bukkit.BukkitContext` for Bukkit-based server plugins. Requires Java 17+.
**Artifact:** `dev.faststats.metrics:bukkit`
-```java
+```java title="ExamplePlugin.java"
import dev.faststats.ErrorTracker;
import dev.faststats.Metrics;
import dev.faststats.bukkit.BukkitContext;
@@ -34,6 +36,10 @@ public final class ExamplePlugin extends JavaPlugin {
}
```
-Call `context.ready()` in `onEnable()` before using metrics or error tracking. On Paper-based servers, this also registers additional exception handlers. See [Error Tracking](/java/error-tracking) for configuring error reporting.
+
+ Call `context.ready()` in `onEnable()` before using metrics or error tracking. On Paper-based servers, this also registers additional exception handlers. See [Error Tracking](/java/error-tracking) for configuring error reporting.
+
-[View full example on GitHub](https://github.com/faststats-dev/faststats-java/blob/main/bukkit/example-plugin/src/main/java/com/example/ExamplePlugin.java)
+
+ [View full example on GitHub](https://github.com/faststats-dev/faststats-java/blob/main/bukkit/example-plugin/src/main/java/com/example/ExamplePlugin.java)
+
diff --git a/content/docs/java/platform/bungeecord.mdx b/src/content/docs/java/platform/bungeecord.mdx
similarity index 70%
rename from content/docs/java/platform/bungeecord.mdx
rename to src/content/docs/java/platform/bungeecord.mdx
index d5c5f8e..d1adc03 100644
--- a/content/docs/java/platform/bungeecord.mdx
+++ b/src/content/docs/java/platform/bungeecord.mdx
@@ -4,11 +4,13 @@ description: Integrate FastStats with BungeeCord proxy plugins
icon: Network
---
+import ReadMore from '@/components/ReadMore.astro';
+
Use `dev.faststats.bungee.BungeeContext` for BungeeCord proxy plugins. Requires Java 17+.
**Artifact:** `dev.faststats.metrics:bungeecord`
-```java
+```java title="ExamplePlugin.java"
import dev.faststats.ErrorTracker;
import dev.faststats.Metrics;
import dev.faststats.bungee.BungeeContext;
@@ -34,6 +36,10 @@ public class ExamplePlugin extends Plugin {
}
```
-See [Error Tracking](/java/error-tracking) for configuring error reporting.
+
+ See [Error Tracking](/java/error-tracking) for configuring error reporting.
+
-[View full example on GitHub](https://github.com/faststats-dev/faststats-java/blob/main/bungeecord/example-plugin/src/main/java/com/example/ExamplePlugin.java)
+
+ [View full example on GitHub](https://github.com/faststats-dev/faststats-java/blob/main/bungeecord/example-plugin/src/main/java/com/example/ExamplePlugin.java)
+
diff --git a/src/content/docs/java/platform/fabric.mdx b/src/content/docs/java/platform/fabric.mdx
new file mode 100644
index 0000000..e423e61
--- /dev/null
+++ b/src/content/docs/java/platform/fabric.mdx
@@ -0,0 +1,58 @@
+---
+title: Fabric
+description: Integrate FastStats with Fabric mods
+icon: Layers
+---
+
+import ReadMore from '@/components/ReadMore.astro';
+import { Aside } from '@astrojs/starlight/components';
+
+Use `dev.faststats.fabric.FabricContext` for Fabric mods. Requires Java 21+.
+
+
+
+**Artifact:** `dev.faststats.metrics:fabric`
+
+```kts
+implementation("dev.faststats.metrics:fabric:0.27.2+mc26.1-26.3")
+```
+
+The version format is `{sdk-version}+mc{from}-{to}`, where `{sdk-version}` is
+the FastStats SDK version and `{from}-{to}` is the supported Minecraft version
+range for that artifact.
+
+```java title="ExampleMod.java"
+import dev.faststats.ErrorTracker;
+import dev.faststats.Metrics;
+import dev.faststats.fabric.FabricContext;
+import net.fabricmc.api.ModInitializer;
+
+public class ExampleMod implements ModInitializer {
+ public static final ErrorTracker ERROR_TRACKER = ErrorTracker.contextAware();
+
+ private final FabricContext context = new FabricContext.Factory("example-mod", "YOUR_TOKEN")
+ .errorTrackerService(ERROR_TRACKER)
+ .metrics(Metrics.Factory::create)
+ .create();
+
+ @Override
+ public void onInitialize() {
+ // your actual logic
+ }
+}
+```
+
+Pass your mod ID, as defined in `fabric.mod.json`, to `FabricContext.Factory`.
+
+
+ See [Error Tracking](/java/error-tracking) for configuring error reporting.
+
+
+
+ [View full example on GitHub](https://github.com/faststats-dev/faststats-java/blob/main/fabric/example-mod/src/main/java/com/example/ExampleMod.java)
+
diff --git a/content/docs/java/platform/hytale.mdx b/src/content/docs/java/platform/hytale.mdx
similarity index 90%
rename from content/docs/java/platform/hytale.mdx
rename to src/content/docs/java/platform/hytale.mdx
index 5634ffc..3913fdb 100644
--- a/content/docs/java/platform/hytale.mdx
+++ b/src/content/docs/java/platform/hytale.mdx
@@ -4,11 +4,13 @@ description: Integrate FastStats with Hytale server plugins
icon: Gamepad2
---
+import ReadMore from '@/components/ReadMore.astro';
+
Use `dev.faststats.hytale.HytaleContext` for Hytale server plugins. Requires Java 25+.
**Artifact:** `dev.faststats.metrics:hytale`
-```java
+```java title="ExamplePlugin.java"
import com.hypixel.hytale.server.core.plugin.JavaPlugin;
import com.hypixel.hytale.server.core.plugin.JavaPluginInit;
import dev.faststats.ErrorTracker;
@@ -40,6 +42,10 @@ public class ExamplePlugin extends JavaPlugin {
}
```
+
See [Error Tracking](/java/error-tracking) for configuring error reporting.
+
+
[View full example on GitHub](https://github.com/faststats-dev/faststats-java/blob/main/hytale/example-plugin/src/main/java/com/example/ExamplePlugin.java)
+
\ No newline at end of file
diff --git a/content/docs/java/platform/minestom.mdx b/src/content/docs/java/platform/minestom.mdx
similarity index 90%
rename from content/docs/java/platform/minestom.mdx
rename to src/content/docs/java/platform/minestom.mdx
index 0f1ea08..01cc96c 100644
--- a/content/docs/java/platform/minestom.mdx
+++ b/src/content/docs/java/platform/minestom.mdx
@@ -4,11 +4,13 @@ description: Integrate FastStats with Minestom servers
icon: Server
---
+import ReadMore from '@/components/ReadMore.astro';
+
Use `dev.faststats.minestom.MinestomContext` for Minestom servers. Requires Java 25+.
**Artifact:** `dev.faststats.metrics:minestom`
-```java
+```java title="ExampleServer.java"
import dev.faststats.ErrorTracker;
import dev.faststats.Metrics;
import dev.faststats.minestom.MinestomContext;
@@ -31,4 +33,6 @@ public final class ExampleServer {
}
```
+
Call `context.ready()` after `MinecraftServer.init()` before using metrics or error tracking. This also registers exception handlers. See [Error Tracking](/java/error-tracking) for configuring error reporting.
+
diff --git a/content/docs/java/platform/neoforge.mdx b/src/content/docs/java/platform/neoforge.mdx
similarity index 56%
rename from content/docs/java/platform/neoforge.mdx
rename to src/content/docs/java/platform/neoforge.mdx
index 94927e8..93cabc9 100644
--- a/content/docs/java/platform/neoforge.mdx
+++ b/src/content/docs/java/platform/neoforge.mdx
@@ -4,16 +4,29 @@ description: Integrate FastStats with NeoForge mods
icon: Hammer
---
-Use `dev.faststats.neoforge.NeoForgeContext` for NeoForge mods. Requires Java 25+.
+import ReadMore from '@/components/ReadMore.astro';
+import { Aside } from '@astrojs/starlight/components';
-
- The NeoForge SDK currently only supports Minecraft version 26.1.2.
- Multi-version support will be added soon.
-
+Use `dev.faststats.neoforge.NeoForgeContext` for NeoForge mods. Requires Java 21+.
+
+
**Artifact:** `dev.faststats.metrics:neoforge`
-```java
+```kts
+implementation("dev.faststats.metrics:neoforge:0.27.2+mc26.1-26.2")
+```
+
+The version format is `{sdk-version}+mc{from}-{to}`, where `{sdk-version}` is
+the FastStats SDK version and `{from}-{to}` is the supported Minecraft version
+range for that artifact.
+
+```java title="ExampleMod.java"
import dev.faststats.ErrorTracker;
import dev.faststats.Metrics;
import dev.faststats.neoforge.NeoForgeContext;
@@ -32,6 +45,10 @@ public class ExampleMod {
Pass your mod ID, as defined in `neoforge.mods.toml`, to `NeoForgeContext.Factory`.
+
See [Error Tracking](/java/error-tracking) for configuring error reporting.
+
+
[View full example on GitHub](https://github.com/faststats-dev/faststats-java/blob/main/neoforge/example-mod/src/main/java/com/example/ExampleMod.java)
+
diff --git a/content/docs/java/platform/nukkit.mdx b/src/content/docs/java/platform/nukkit.mdx
similarity index 90%
rename from content/docs/java/platform/nukkit.mdx
rename to src/content/docs/java/platform/nukkit.mdx
index a4400e6..08a83ec 100644
--- a/content/docs/java/platform/nukkit.mdx
+++ b/src/content/docs/java/platform/nukkit.mdx
@@ -4,11 +4,13 @@ description: Integrate FastStats with Nukkit plugins
icon: Plug
---
+import ReadMore from '@/components/ReadMore.astro';
+
Use `dev.faststats.nukkit.NukkitContext` for Nukkit plugins. Requires Java 17+.
**Artifact:** `dev.faststats.metrics:nukkit`
-```java
+```java title="ExamplePlugin.java"
import cn.nukkit.plugin.PluginBase;
import dev.faststats.ErrorTracker;
import dev.faststats.Metrics;
@@ -39,4 +41,6 @@ public final class ExamplePlugin extends PluginBase {
}
```
+
See [Error Tracking](/java/error-tracking) for configuring error reporting.
+
diff --git a/content/docs/java/platform/sponge.mdx b/src/content/docs/java/platform/sponge.mdx
similarity index 92%
rename from content/docs/java/platform/sponge.mdx
rename to src/content/docs/java/platform/sponge.mdx
index 5b1994f..dc402f9 100644
--- a/content/docs/java/platform/sponge.mdx
+++ b/src/content/docs/java/platform/sponge.mdx
@@ -4,11 +4,13 @@ description: Integrate FastStats with Sponge plugins
icon: Circle
---
+import ReadMore from '@/components/ReadMore.astro';
+
Use `dev.faststats.sponge.SpongeContext` for Sponge plugins. Requires Java 17+.
**Artifact:** `dev.faststats.metrics:sponge`
-```java
+```java title="ExamplePlugin.java"
import com.google.inject.Inject;
import dev.faststats.ErrorTracker;
import dev.faststats.Metrics;
@@ -44,6 +46,10 @@ public class ExamplePlugin {
}
```
+
See [Error Tracking](/java/error-tracking) for configuring error reporting.
+
+
[View full example on GitHub](https://github.com/faststats-dev/faststats-java/blob/main/sponge/example-plugin/src/main/java/com/example/ExamplePlugin.java)
+
diff --git a/content/docs/java/platform/velocity.mdx b/src/content/docs/java/platform/velocity.mdx
similarity index 92%
rename from content/docs/java/platform/velocity.mdx
rename to src/content/docs/java/platform/velocity.mdx
index 2d111cd..f8a622c 100644
--- a/content/docs/java/platform/velocity.mdx
+++ b/src/content/docs/java/platform/velocity.mdx
@@ -4,11 +4,13 @@ description: Integrate FastStats with Velocity proxy plugins
icon: Zap
---
+import ReadMore from '@/components/ReadMore.astro';
+
Use `dev.faststats.velocity.VelocityContext` for Velocity proxy plugins. Requires Java 21+.
**Artifact:** `dev.faststats.metrics:velocity`
-```java
+```java title="ExamplePlugin.java"
import com.google.inject.Inject;
import com.velocitypowered.api.event.Subscribe;
import com.velocitypowered.api.event.proxy.ProxyInitializeEvent;
@@ -45,6 +47,10 @@ public class ExamplePlugin {
}
```
+
See [Error Tracking](/java/error-tracking) for configuring error reporting.
+
+
[View full example on GitHub](https://github.com/faststats-dev/faststats-java/blob/main/velocity/example-plugin/src/main/java/com/example/ExamplePlugin.java)
+
diff --git a/content/docs/java/system-properties.mdx b/src/content/docs/java/system-properties.mdx
similarity index 100%
rename from content/docs/java/system-properties.mdx
rename to src/content/docs/java/system-properties.mdx
diff --git a/src/content/docs/platform/chart-editor/flow-nodes.mdx b/src/content/docs/platform/chart-editor/flow-nodes.mdx
new file mode 100644
index 0000000..92ee36a
--- /dev/null
+++ b/src/content/docs/platform/chart-editor/flow-nodes.mdx
@@ -0,0 +1,257 @@
+---
+title: Flow Nodes
+description: All available nodes for building data pipelines in the flow editor
+icon: Workflow
+---
+
+import NodePreview from "@/components/docs/node-preview.astro";
+
+import NodeDocCard from "@/components/NodeDocCard.astro";
+
+The Flow Editor lets you build chart queries by connecting nodes in a pipeline. Drag nodes onto the canvas, configure them, and wire them together. Data flows from top to bottom, starting at a **Data Source**, passing through transformations, and ending at an **Output**.
+
+## Getting started
+
+1. Add a **Data Source** node to choose which adapter and field to read from
+2. Connect transformation nodes like **Filter**, **Group By**, or **Aggregate** to shape the data
+3. Finish with an **Output** node to produce the chart result
+
+Each node has handles on its top and/or bottom edge. Connect the bottom handle of one node to the top handle of the next to build the pipeline. The colored badge on each node shows its category. Sources, filters, aggregates, groupings, transforms, time operations, and outputs each have their own color.
+
+## Nodes
+
+### Data Source
+
+
+
+
+
+---
+
+### Filter
+
+
+
+
+
+---
+
+### Aggregate
+
+
+
+
+
+---
+
+### Group By
+
+
+
+
+
+---
+
+### Time Group
+
+
+
+
+
+---
+
+### Text Transform
+
+
+
+
+
+---
+
+### Formula
+
+
+
+
+
+---
+
+### Limit
+
+Other bucket so totals still match."
+ }
+ ]}>
+
+
+
+---
+
+### Max Age
+
+ms, seconds, minutes, hours, days."
+ }
+ ]}>
+
+
+
+---
+
+### Min Age
+
+Max Age."
+ }
+ ]}>
+
+
+
+---
+
+### Output
+
+/ to split a URL path)."
+ }
+ ]}>
+
+
\ No newline at end of file
diff --git a/content/docs/platform/chart-editor/index.mdx b/src/content/docs/platform/chart-editor/index.mdx
similarity index 69%
rename from content/docs/platform/chart-editor/index.mdx
rename to src/content/docs/platform/chart-editor/index.mdx
index 027b39e..503f450 100644
--- a/content/docs/platform/chart-editor/index.mdx
+++ b/src/content/docs/platform/chart-editor/index.mdx
@@ -1,26 +1,25 @@
---
-title: Chart Editor
+title: Overview
description: Build and configure charts using the visual flow editor
icon: ChartArea
---
-import { Cards, Card } from "fumadocs-ui/components/card";
+import { LinkCard, CardGrid } from '@astrojs/starlight/components';
The Chart Editor is where you build charts in fastStats. Connect nodes on a canvas to choose your data, transform it, and decide how it shows up in the chart.
-
-
- Every node in the editor: Data Source, Filter, Aggregate, Group By, Time
- Group, Formula, and more.
-
-
+
+
- How tabs, multi-line charts, and stacked bars work when you add more than
- one Output node.
-
-
+ description="How tabs, multi-line charts, and stacked bars work when you add more than one Output node."
+ />
+
## How it works
diff --git a/content/docs/platform/chart-editor/output-nodes.mdx b/src/content/docs/platform/chart-editor/output-nodes.mdx
similarity index 93%
rename from content/docs/platform/chart-editor/output-nodes.mdx
rename to src/content/docs/platform/chart-editor/output-nodes.mdx
index a8e45b8..f900725 100644
--- a/content/docs/platform/chart-editor/output-nodes.mdx
+++ b/src/content/docs/platform/chart-editor/output-nodes.mdx
@@ -4,13 +4,13 @@ description: How to create tabs, multi-line charts, and stacked bars using multi
icon: GitFork
---
-import { ResultNodePreview } from "@/components/docs/node-preview";
-import { Callout } from "fumadocs-ui/components/callout";
+import { Aside } from '@astrojs/starlight/components';
+import NodePreview from "@/components/docs/node-preview.astro";
The Output node is the last step in every pipeline. One Output gives you a simple chart. Add more Output nodes to build multi-line charts, stacked bars, or tabbed lists.
-
-
+
+
## Output settings
@@ -32,9 +32,9 @@ When a flow has more than one Output node, each one runs as its own pipeline. Th
Output nodes are ordered by where they sit on the canvas. The leftmost Output becomes the first series, the next one becomes the second, and so on.
-
+
+
## Multi-line charts
diff --git a/content/docs/platform/error-tracking/index.mdx b/src/content/docs/platform/error-tracking.mdx
similarity index 55%
rename from content/docs/platform/error-tracking/index.mdx
rename to src/content/docs/platform/error-tracking.mdx
index b8adc0d..0ede3d4 100644
--- a/content/docs/platform/error-tracking/index.mdx
+++ b/src/content/docs/platform/error-tracking.mdx
@@ -1,13 +1,12 @@
---
title: Error Tracking
description: How to track errors in your application
-icon: Bug
---
-FastStats allows you to track errors in your application.
-For this, you have to enable Error Tracking in your project settings under
+import ReadMore from '@/components/ReadMore.astro';
-Features.
+FastStats allows you to track errors in your application.
+For this, you have to enable Error Tracking in your project settings under Features.
## Data Retention
@@ -17,7 +16,9 @@ longer be accessed.
## Implementation
-- For Plugin / Mod projects, follow the
- [Java SDK documentation](/java/configuration#error-tracking)
-- For Web Analytics projects, follow the
- [Web SDK documentation](/web-analytics)
+
+ For Plugin / Mod projects, follow the [Java SDK documentation](/java/configuration#error-tracking)
+
+
+ For Web Analytics projects, follow the [Web SDK documentation](/web-analytics)
+
diff --git a/content/docs/platform/guide/badges.mdx b/src/content/docs/platform/guide/badges.mdx
similarity index 100%
rename from content/docs/platform/guide/badges.mdx
rename to src/content/docs/platform/guide/badges.mdx
diff --git a/content/docs/platform/guide/embed.mdx b/src/content/docs/platform/guide/embed.mdx
similarity index 95%
rename from content/docs/platform/guide/embed.mdx
rename to src/content/docs/platform/guide/embed.mdx
index 7f0d862..e33c6b0 100644
--- a/content/docs/platform/guide/embed.mdx
+++ b/src/content/docs/platform/guide/embed.mdx
@@ -4,8 +4,7 @@ description: Embed charts in your documentation or website
icon: Image
---
-Embed your FastStats charts anywhere
-READMEs, documentation, dashboards, or any platform that supports images.
+Embed your FastStats charts anywhere READMEs, documentation, dashboards, or any platform that supports images.
## Usage
diff --git a/content/docs/platform/hotkeys.mdx b/src/content/docs/platform/hotkeys.mdx
similarity index 95%
rename from content/docs/platform/hotkeys.mdx
rename to src/content/docs/platform/hotkeys.mdx
index f998327..3b93e68 100644
--- a/content/docs/platform/hotkeys.mdx
+++ b/src/content/docs/platform/hotkeys.mdx
@@ -4,14 +4,16 @@ description: Keyboard shortcuts in the FastStats dashboard
icon: Keyboard
---
+import { Aside } from '@astrojs/starlight/components';
+
Use keyboard shortcuts to move around the dashboard and open common actions without reaching for the mouse.
Most navigation shortcuts are **key sequences**: press the first key, then the second (for example, `G` then `S`). They only work when your focus is not inside a text field.
-
+
+
## Project navigation
diff --git a/content/docs/platform/index.mdx b/src/content/docs/platform/index.mdx
similarity index 80%
rename from content/docs/platform/index.mdx
rename to src/content/docs/platform/index.mdx
index af84747..cdff7e5 100644
--- a/content/docs/platform/index.mdx
+++ b/src/content/docs/platform/index.mdx
@@ -4,18 +4,22 @@ description: Your introduction to FastStats
icon: BookOpen
---
+import { LinkCard, CardGrid } from '@astrojs/starlight/components';
+
FastStats is a metrics platform made for developers. Collect custom events, monitor performance, and gain insights through focused dashboards.
## Get Started
-
-
- Publish charts anywhere that supports images.
-
-
- Shields.io badges for servers, players, events, and more.
-
-
+
+
+
+
## SDKs
diff --git a/content/docs/platform/retention/index.mdx b/src/content/docs/platform/retention.mdx
similarity index 97%
rename from content/docs/platform/retention/index.mdx
rename to src/content/docs/platform/retention.mdx
index cba3424..c0d31c6 100644
--- a/content/docs/platform/retention/index.mdx
+++ b/src/content/docs/platform/retention.mdx
@@ -1,7 +1,6 @@
---
title: Retention
description: Measure how many users come back over time with cohort-based retention charts.
-icon: RefreshCcw
---
export const mockCohortRows = [
@@ -17,7 +16,7 @@ Retention shows how many users return after their first seen period. FastStats g
Static preview from the retention page. This example is not interactive.
-
+
diff --git a/content/docs/web-analytics/configuration.mdx b/src/content/docs/web-analytics/configuration.mdx
similarity index 97%
rename from content/docs/web-analytics/configuration.mdx
rename to src/content/docs/web-analytics/configuration.mdx
index 8695de9..5a83477 100644
--- a/content/docs/web-analytics/configuration.mdx
+++ b/src/content/docs/web-analytics/configuration.mdx
@@ -4,6 +4,8 @@ description: Every option you can pass to FastStats Web Analytics
icon: Settings
---
+import ReadMore from '@/components/ReadMore.astro';
+
All packages share the same set of options. In React you pass them as props on
the `Analytics` component, in Nuxt you set them under the `faststats` key, and in
plain JavaScript you pass them to the `WebAnalytics` constructor.
@@ -32,7 +34,9 @@ errorTracking: {
| --------- | --------- | ------- | -------------------- |
| `enabled` | `boolean` | `false` | Turns the tracker on |
+
Read more in [Error Tracking](/web-analytics/error-tracking).
+
### Web Vitals
@@ -48,7 +52,9 @@ webVitals: {
| `enabled` | `boolean` | `false` | Turns the tracker on |
| `attribution` | `boolean` | `false` | Adds debug attribution data to each metric |
+
Read more in [Web Vitals](/web-analytics/web-vitals).
+
### Session Replays
@@ -70,8 +76,10 @@ replayOptions: {
| `replayOptions.maxEvents` | `number` | `1000` | Flush after this many buffered rrweb events |
| `replayOptions.maxBatchSizeBytes` | `number` | `524288` | Flush after the buffered event payload reaches this size |
+
For masking and recording details see
[Session Replay](/web-analytics/session-replay).
+
### Consent
@@ -87,7 +95,9 @@ consent: {
| `mode` | `"pending" \| "granted" \| "denied"` | `"granted"` | The current consent state |
| `pendingBehavior` | `"anonymous" \| "disabled"` | `"anonymous"` | Cookieless tracking while consent is pending, or no tracking at all |
+
Read more in [Consent and Cookieless](/web-analytics/consent).
+
## Manual Start
diff --git a/content/docs/web-analytics/consent.mdx b/src/content/docs/web-analytics/consent.mdx
similarity index 85%
rename from content/docs/web-analytics/consent.mdx
rename to src/content/docs/web-analytics/consent.mdx
index 879fa02..6770093 100644
--- a/content/docs/web-analytics/consent.mdx
+++ b/src/content/docs/web-analytics/consent.mdx
@@ -4,9 +4,11 @@ description: Run analytics with or without stored identifiers
icon: ShieldCheck
---
-
+import { Aside, Tabs, TabItem } from '@astrojs/starlight/components';
+
+
+
The SDK supports cookieless mode and three consent states: `pending`, `granted`,
and `denied`. Switch modes at runtime with `setConsentMode`, `optIn`, or
@@ -23,15 +25,15 @@ visitors cannot be recognized across reloads.
Set `cookieless` to `true` to never store an identifier.
-
-
+
+
```tsx
```
-
-
+
+
```ts title="nuxt.config.ts"
faststats: {
@@ -40,14 +42,14 @@ faststats: {
}
```
-
-
+
+
```ts
new WebAnalytics({ siteKey: "your_site_key", cookieless: true });
```
-
+
@@ -79,8 +81,8 @@ Call `optIn` or `optOut` from your banner buttons, or call `setConsentMode` for
full control. The SDK switches storage behavior right away and tells the replay
and other trackers about the change.
-
-
+
+
```tsx
import { optIn, optOut } from "@faststats/react";
@@ -89,8 +91,8 @@ import { optIn, optOut } from "@faststats/react";
```
-
-
+
+
```ts
import { optIn, optOut, setConsentMode } from "@faststats/web";
@@ -100,14 +102,14 @@ optOut(); // same as setConsentMode("denied")
setConsentMode("pending");
```
-
+
-
+
+
## React Consent Prop
diff --git a/content/docs/web-analytics/error-tracking.mdx b/src/content/docs/web-analytics/error-tracking.mdx
similarity index 89%
rename from content/docs/web-analytics/error-tracking.mdx
rename to src/content/docs/web-analytics/error-tracking.mdx
index 0e9c413..1efa4bd 100644
--- a/content/docs/web-analytics/error-tracking.mdx
+++ b/src/content/docs/web-analytics/error-tracking.mdx
@@ -4,6 +4,8 @@ description: Capture client and server errors
icon: Bug
---
+import { Tabs, TabItem } from '@astrojs/starlight/components';
+
Browser errors are reported by the web SDK. Server errors in Nitro routes are
reported by `@faststats/nitro`.
@@ -13,15 +15,15 @@ Turn on `errorTracking.enabled` to capture uncaught errors and unhandled promise
rejections. The tracker batches them and drops noise from browser extensions
automatically.
-
-
+
+
```tsx
```
-
-
+
+
```ts title="nuxt.config.ts"
faststats: {
@@ -30,8 +32,8 @@ faststats: {
}
```
-
-
+
+
```ts
new WebAnalytics({
@@ -40,7 +42,7 @@ new WebAnalytics({
});
```
-
+
@@ -72,10 +74,10 @@ If you run Nitro, either standalone or through Nuxt, you can report errors throw
in server routes with `@faststats/nitro`. The package ships a plugin for Nitro
v2 and one for Nitro v3.
-`npm npm install @faststats/nitro `
+`npm install @faststats/nitro `
-
-
+
+
```ts title="nuxt.config.ts"
import { createRequire } from "node:module";
@@ -90,8 +92,8 @@ export default defineNuxtConfig({
});
```
-
-
+
+
```ts title="nitro.config.ts"
export default defineNitroConfig({
@@ -99,7 +101,7 @@ export default defineNitroConfig({
});
```
-
+
diff --git a/content/docs/web-analytics/events.mdx b/src/content/docs/web-analytics/events.mdx
similarity index 86%
rename from content/docs/web-analytics/events.mdx
rename to src/content/docs/web-analytics/events.mdx
index 576d70d..94d3a92 100644
--- a/content/docs/web-analytics/events.mdx
+++ b/src/content/docs/web-analytics/events.mdx
@@ -4,6 +4,9 @@ description: Automatic tracking and custom events
icon: MousePointerClick
---
+import ReadMore from '@/components/ReadMore.astro';
+import { Tabs, TabItem } from '@astrojs/starlight/components';
+
The SDK sends `pageview`, `page_leave`, and `outbound_link` events
automatically. Use `trackEvent` for custom events.
@@ -23,16 +26,19 @@ spent on the page, the deepest scroll depth in percent and the session duration.
Single page navigation is detected through the History API, so `pushState`,
`replaceState` and the back and forward buttons all create new page views. Hash
-based routers need `trackHash` turned on. See
-[Configuration](/web-analytics/configuration).
+based routers need `trackHash` turned on.
+
+
+See [Configuration](/web-analytics/configuration).
+
## Custom Events
Call `trackEvent` with a name and an optional object of properties. Use clear,
lower case names so they read well in your dashboard.
-
-
+
+
```tsx
import { trackEvent } from "@faststats/react";
@@ -40,8 +46,8 @@ import { trackEvent } from "@faststats/react";
trackEvent("signup", { plan: "pro", source: "hero" });
```
-
-
+
+
```ts
import { trackEvent } from "@faststats/web";
@@ -49,7 +55,7 @@ import { trackEvent } from "@faststats/web";
trackEvent("signup", { plan: "pro", source: "hero" });
```
-
+
diff --git a/content/docs/web-analytics/feature-flags.mdx b/src/content/docs/web-analytics/feature-flags.mdx
similarity index 97%
rename from content/docs/web-analytics/feature-flags.mdx
rename to src/content/docs/web-analytics/feature-flags.mdx
index 3ce6549..d796da6 100644
--- a/content/docs/web-analytics/feature-flags.mdx
+++ b/src/content/docs/web-analytics/feature-flags.mdx
@@ -4,10 +4,12 @@ description: Evaluate FastStats feature flags in the browser
icon: Flag
---
-
+import { Aside } from '@astrojs/starlight/components';
+
+
+
Evaluate a flag for the current visitor with `useFlag` in React or
`checkFeatureFlag` on the SDK instance. The response includes the value and,
diff --git a/content/docs/web-analytics/identify.mdx b/src/content/docs/web-analytics/identify.mdx
similarity index 90%
rename from content/docs/web-analytics/identify.mdx
rename to src/content/docs/web-analytics/identify.mdx
index a0a2d92..a96ab4e 100644
--- a/content/docs/web-analytics/identify.mdx
+++ b/src/content/docs/web-analytics/identify.mdx
@@ -4,6 +4,8 @@ description: Attach a known identity to a visitor
icon: UserCheck
---
+import { Aside, Tabs, TabItem } from '@astrojs/starlight/components';
+
Call `identify` after sign-in to link the anonymous visitor id to an external
user id and profile fields.
@@ -12,8 +14,8 @@ user id and profile fields.
Pass a stable external id and an email. The external id should be the same value
your own system uses for that user, such as a database id.
-
-
+
+
```tsx
import { identify } from "@faststats/react";
@@ -24,8 +26,8 @@ await identify("user_123", "ada@example.com", {
});
```
-
-
+
+
```ts
import { identify } from "@faststats/web";
@@ -36,7 +38,7 @@ await identify("user_123", "ada@example.com", {
});
```
-
+
@@ -62,10 +64,10 @@ if (!ok) {
}
```
-
+
+
## Log Out
diff --git a/content/docs/web-analytics/index.mdx b/src/content/docs/web-analytics/index.mdx
similarity index 56%
rename from content/docs/web-analytics/index.mdx
rename to src/content/docs/web-analytics/index.mdx
index 0490de6..18c5f20 100644
--- a/content/docs/web-analytics/index.mdx
+++ b/src/content/docs/web-analytics/index.mdx
@@ -4,7 +4,12 @@ description: Add FastStats Web Analytics to your website or web app
icon: Download
---
-Web Analytics is not yet publicly available
+import ReadMore from '@/components/ReadMore.astro';
+import { Aside, Tabs, TabItem } from '@astrojs/starlight/components';
+
+
Install one of the packages below and pass your site key.
@@ -18,10 +23,22 @@ Install one of the packages below and pass your site key.
## Install
-
- `npm npm install @faststats/react`
- `npm npm install @faststats/nuxt`
- `npm npm install @faststats/web`
+
+
+ ```sh
+ npm install @faststats/react
+ ```
+
+
+ ```sh
+ npm install @faststats/nuxt
+ ```
+
+
+ ```sh
+ npm install @faststats/web
+ ```
+
## Get Your Site Key
@@ -32,6 +49,8 @@ events for that one project.
## Next Steps
-- [Configuration](/web-analytics/configuration): all SDK options
-- [Events](/web-analytics/events): automatic and custom tracking
-- [Consent and Cookieless](/web-analytics/consent): cookieless mode and consent states
+[Configuration](/web-analytics/configuration): all SDK options
+
+[Events](/web-analytics/events): automatic and custom tracking
+
+[Consent and Cookieless](/web-analytics/consent): cookieless mode and consent states
diff --git a/content/docs/web-analytics/javascript.mdx b/src/content/docs/web-analytics/javascript.mdx
similarity index 99%
rename from content/docs/web-analytics/javascript.mdx
rename to src/content/docs/web-analytics/javascript.mdx
index 7fdc584..bede5fd 100644
--- a/content/docs/web-analytics/javascript.mdx
+++ b/src/content/docs/web-analytics/javascript.mdx
@@ -11,7 +11,7 @@ full control over the lifecycle.
## Install
-```npm
+```sh
npm install @faststats/web
```
diff --git a/content/docs/web-analytics/nuxt.mdx b/src/content/docs/web-analytics/nuxt.mdx
similarity index 89%
rename from content/docs/web-analytics/nuxt.mdx
rename to src/content/docs/web-analytics/nuxt.mdx
index 1cc7ca6..6787914 100644
--- a/content/docs/web-analytics/nuxt.mdx
+++ b/src/content/docs/web-analytics/nuxt.mdx
@@ -4,13 +4,15 @@ description: Add FastStats Web Analytics to a Nuxt app
icon: Mountain
---
+import ReadMore from '@/components/ReadMore.astro';
+
The `@faststats/nuxt` module sets up the browser SDK for you. It reads its
configuration from your `nuxt.config`, starts tracking on the client and wires
the SDK into the Vue error handler so unhandled component errors are reported.
## Install
-```npm
+```sh
npm install @faststats/nuxt
```
@@ -30,8 +32,10 @@ export default defineNuxtConfig({
});
```
+
The module accepts every option from the SDK. See
[Configuration](/web-analytics/configuration) for the full list.
+
## Use Environment Variables
@@ -70,7 +74,9 @@ Nuxt runs on Nitro, so you can report errors thrown in server routes with the
`@faststats/nitro` plugin. Install it and register the plugin that matches your
Nitro version.
-`npm npm install @faststats/nitro `
+```sh
+npm install @faststats/nitro
+```
```ts title="nuxt.config.ts"
import { createRequire } from "node:module";
@@ -89,6 +95,6 @@ export default defineNuxtConfig({
});
```
-The server plugin needs its own project token through `FASTSTATS_TOKEN`. Read
-the server section in [Error Tracking](/web-analytics/error-tracking) for the
-details.
+
+The server plugin needs its own project token through `FASTSTATS_TOKEN`. Read the server section in [Error Tracking](/web-analytics/error-tracking) for the details.
+
\ No newline at end of file
diff --git a/content/docs/web-analytics/react.mdx b/src/content/docs/web-analytics/react.mdx
similarity index 91%
rename from content/docs/web-analytics/react.mdx
rename to src/content/docs/web-analytics/react.mdx
index 33bb14f..50ab219 100644
--- a/content/docs/web-analytics/react.mdx
+++ b/src/content/docs/web-analytics/react.mdx
@@ -4,12 +4,15 @@ description: Add FastStats Web Analytics to a React or Next.js app
icon: Atom
---
+import ReadMore from '@/components/ReadMore.astro';
+import { Aside, Tabs, TabItem } from '@astrojs/starlight/components';
+
The `@faststats/react` package wraps the browser SDK in a single component and a
set of hooks. It works with any React app and with the Next.js App Router.
## Install
-```npm
+```sh
npm install @faststats/react
```
@@ -19,8 +22,8 @@ Render the `Analytics` component once, near the root of your app. It starts
tracking when it mounts and cleans up when it unmounts. You never have to create
an instance by hand.
-
-
+
+
```tsx title="app/layout.tsx"
import { Analytics } from "@faststats/react";
@@ -41,8 +44,8 @@ export default function RootLayout({
}
```
-
-
+
+
```tsx title="src/main.tsx"
import { Analytics } from "@faststats/react";
@@ -58,7 +61,7 @@ createRoot(document.getElementById("root")!).render(
);
```
-
+
@@ -74,7 +77,9 @@ turns on a few extra features.
/>
```
+
See [Configuration](/web-analytics/configuration) for the full list.
+
## Track Custom Events
@@ -139,12 +144,16 @@ return (
| `useOptOut` | The `optOut` function |
| `useFlag` | A feature flag value with loading and error state |
+
Read more in [Events](/web-analytics/events),
[Identify](/web-analytics/identify) and
[Feature Flags](/web-analytics/feature-flags).
+
## Server Side Routes
+
The React package only runs in the browser. If you also want to capture errors
thrown in Next.js route handlers or server functions, read the server section in
[Error Tracking](/web-analytics/error-tracking).
+
\ No newline at end of file
diff --git a/content/docs/web-analytics/session-replay.mdx b/src/content/docs/web-analytics/session-replay.mdx
similarity index 90%
rename from content/docs/web-analytics/session-replay.mdx
rename to src/content/docs/web-analytics/session-replay.mdx
index 615ccda..4cc44a7 100644
--- a/content/docs/web-analytics/session-replay.mdx
+++ b/src/content/docs/web-analytics/session-replay.mdx
@@ -4,6 +4,8 @@ description: Record DOM sessions with rrweb
icon: Video
---
+import { Aside, Tabs, TabItem } from '@astrojs/starlight/components';
+
Session replay records DOM mutations and user interactions using
[rrweb](https://www.rrweb.io/). Recordings are serialized events, not video.
@@ -11,15 +13,15 @@ Session replay records DOM mutations and user interactions using
Turn it on with the object form.
-
-
+
+
```tsx
```
-
-
+
+
```ts title="nuxt.config.ts"
faststats: {
@@ -28,8 +30,8 @@ faststats: {
}
```
-
-
+
+
```ts
new WebAnalytics({
@@ -38,7 +40,7 @@ new WebAnalytics({
});
```
-
+
diff --git a/content/docs/web-analytics/sourcemaps.mdx b/src/content/docs/web-analytics/sourcemaps.mdx
similarity index 93%
rename from content/docs/web-analytics/sourcemaps.mdx
rename to src/content/docs/web-analytics/sourcemaps.mdx
index 12f2371..e0a380c 100644
--- a/content/docs/web-analytics/sourcemaps.mdx
+++ b/src/content/docs/web-analytics/sourcemaps.mdx
@@ -4,6 +4,8 @@ description: Upload JavaScript sourcemaps so FastStats can show readable stack t
icon: FileBracesCorner
---
+import { Aside, Tabs, TabItem } from '@astrojs/starlight/components';
+
FastStats can turn minified browser stack traces back into the original file,
line and column when you upload the sourcemaps from the same build.
@@ -17,7 +19,7 @@ sourcemap.
Install the package in the app that builds your frontend.
-```npm
+```sh
npm install --save-dev @faststats/sourcemap-uploader-plugin
```
@@ -34,8 +36,8 @@ Turn on sourcemap output in your bundler, then add the FastStats plugin. The
default upload endpoint is `https://sourcemaps.faststats.dev/v0/upload`, so most
projects only need to pass `authToken`.
-
-
+
+
```ts title="vite.config.ts"
import { defineConfig } from "vite";
@@ -53,8 +55,8 @@ export default defineConfig({
});
```
-
-
+
+
```ts title="rollup.config.ts"
import sourcemapsPlugin from "@faststats/sourcemap-uploader-plugin/rollup";
@@ -74,8 +76,8 @@ export default {
};
```
-
-
+
+
```ts title="webpack.config.ts"
import sourcemapsPlugin from "@faststats/sourcemap-uploader-plugin/webpack";
@@ -90,8 +92,8 @@ export default {
};
```
-
-
+
+
```ts title="rspack.config.ts"
import sourcemapsPlugin from "@faststats/sourcemap-uploader-plugin/rspack";
@@ -106,8 +108,8 @@ export default {
};
```
-
-
+
+
```ts title="build.ts"
import { build } from "esbuild";
@@ -126,7 +128,7 @@ await build({
});
```
-
+
The package also exports `rolldown`, `farm`, `bun` and `unloader` adapters. Use
diff --git a/content/docs/web-analytics/web-vitals.mdx b/src/content/docs/web-analytics/web-vitals.mdx
similarity index 83%
rename from content/docs/web-analytics/web-vitals.mdx
rename to src/content/docs/web-analytics/web-vitals.mdx
index c771de5..f873426 100644
--- a/content/docs/web-analytics/web-vitals.mdx
+++ b/src/content/docs/web-analytics/web-vitals.mdx
@@ -4,6 +4,8 @@ description: Report Core Web Vitals from the browser SDK
icon: Gauge
---
+import { Aside, Tabs, TabItem } from '@astrojs/starlight/components';
+
Set `webVitals.enabled` to report LCP, CLS, INP, FCP, and TTFB from visitor
sessions.
@@ -11,15 +13,15 @@ sessions.
Turn the feature on with the object form so you can also set attribution.
-
-
+
+
```tsx
```
-
-
+
+
```ts title="nuxt.config.ts"
faststats: {
@@ -28,8 +30,8 @@ faststats: {
}
```
-
-
+
+
```ts
new WebAnalytics({
@@ -38,7 +40,7 @@ new WebAnalytics({
});
```
-
+
diff --git a/src/integrations/dev-file-watcher.ts b/src/integrations/dev-file-watcher.ts
new file mode 100644
index 0000000..5735040
--- /dev/null
+++ b/src/integrations/dev-file-watcher.ts
@@ -0,0 +1,35 @@
+import { glob } from 'node:fs/promises';
+import type { AstroIntegration } from 'astro';
+import { fileURLToPath } from 'node:url';
+
+/**
+ * Astro integration that registers the passed paths so that saving them triggers a dev server
+ * restart.
+ *
+ * It also supports passing glob patterns to watch a set of files matching a specific pattern.
+ *
+ * @param paths Array of file paths relative to the project root.
+ *
+ * @example
+ * // astro.config.mjs
+ * export default {
+ * integrations: [
+ * devServerFileWatcher(["./example.js", "./src/content/demo/*.yml"]),
+ * ],
+ * }
+ */
+export const devServerFileWatcher = (paths: string[]) =>
+ ({
+ name: 'dev-server-file-watcher',
+ hooks: {
+ async 'astro:config:setup'({ addWatchFile, config }) {
+ const cwd = fileURLToPath(config.root);
+
+ for (const path of paths) {
+ for await (const file of glob(path, { cwd })) {
+ addWatchFile(new URL(file, config.root));
+ }
+ }
+ },
+ },
+ }) satisfies AstroIntegration;
diff --git a/src/lib/docs-tabs.tsx b/src/lib/docs-tabs.tsx
deleted file mode 100644
index ef9dac0..0000000
--- a/src/lib/docs-tabs.tsx
+++ /dev/null
@@ -1,73 +0,0 @@
-import type { Root } from "fumadocs-core/page-tree";
-import {
- type GetLayoutTabsOptions,
- getLayoutTabs,
- type LayoutTab,
-} from "fumadocs-ui/layouts/shared";
-import { BookOpen, Coffee, Globe, LayoutDashboard } from "lucide-react";
-
-const transform: NonNullable = (
- option,
- node,
-) => {
- if (node.$id === "platform") {
- return {
- ...option,
- url: "/platform",
- title: (
-
-
- Platform
-
- ),
- };
- }
-
- if (node.$id === "java") {
- return {
- ...option,
- url: "/java",
- title: (
-
-
- Java
-
- ),
- };
- }
-
- if (node.$id === "api") {
- return {
- ...option,
- url: "/api",
- title: (
-
-
- Rest API
-
- ),
- };
- }
-
- if (node.$id === "web-analytics") {
- return {
- ...option,
- url: "/web-analytics",
- title: (
-
-
- Web Analytics
-
- Coming Soon
-
-
- ),
- };
- }
-
- return option;
-};
-
-export function getDocsTabs(tree: Root): LayoutTab[] {
- return getLayoutTabs(tree, { transform });
-}
diff --git a/src/lib/layout.shared.tsx b/src/lib/layout.shared.tsx
deleted file mode 100644
index ce0371f..0000000
--- a/src/lib/layout.shared.tsx
+++ /dev/null
@@ -1,47 +0,0 @@
-import type { BaseLayoutProps } from "fumadocs-ui/layouts/shared";
-import type { ReactNode, SVGProps } from "react";
-import { SiteBrand } from "@/components/site-brand";
-
-function DiscordIcon({
- className,
- ...props
-}: SVGProps): ReactNode {
- return (
-
- );
-}
-
-export const docsSocialLinks = [
- {
- url: "https://github.com/faststats-dev",
- label: "GitHub",
- icon: "github" as const,
- external: true,
- },
- {
- url: "https://discord.com/invite/SKnDU5VwMS",
- label: "Discord",
- icon: ,
- external: true,
- },
-];
-
-export function baseOptions(): BaseLayoutProps {
- return {
- nav: {
- title: ,
- url: "/platform",
- },
- };
-}
diff --git a/src/lib/openapi.ts b/src/lib/openapi.ts
deleted file mode 100644
index ca33cef..0000000
--- a/src/lib/openapi.ts
+++ /dev/null
@@ -1,20 +0,0 @@
-import { createOpenAPI } from "fumadocs-openapi/server";
-
-const API_ORIGIN = "https://api.faststats.dev";
-const openApiUrl = `${API_ORIGIN}/openapi.json`;
-
-const schema = await fetch(openApiUrl).then((response) => {
- if (!response.ok) {
- throw new Error(
- `Failed to fetch OpenAPI schema from ${openApiUrl}: ${response.status}`,
- );
- }
-
- return response.json();
-});
-
-export const openapi = createOpenAPI({
- input: {
- [openApiUrl]: schema,
- },
-});
diff --git a/src/lib/source.ts b/src/lib/source.ts
deleted file mode 100644
index 4abe350..0000000
--- a/src/lib/source.ts
+++ /dev/null
@@ -1,56 +0,0 @@
-import { type InferPageType, loader } from "fumadocs-core/source";
-import { lucideIconsPlugin } from "fumadocs-core/source/lucide-icons";
-import { docs } from "fumadocs-mdx:collections/server";
-import { openapiPlugin, openapiSource } from "fumadocs-openapi/server";
-import { openapi } from "@/lib/openapi";
-
-const openapiDocs = await openapiSource(openapi, {
- baseDir: "api",
- meta: true,
- groupBy: "tag",
-});
-
-const openapiRootMeta = openapiDocs.files.find(
- (file) => file.path === "api/meta.json",
-);
-if (openapiRootMeta?.type === "meta") {
- openapiRootMeta.data = {
- ...openapiRootMeta.data,
- root: true,
- title: "Rest API",
- icon: "BookOpen",
- pages: ["index", ...(openapiRootMeta.data.pages ?? [])],
- };
-}
-
-export const source = loader(
- {
- docs: docs.toFumadocsSource(),
- openapi: openapiDocs,
- },
- {
- baseUrl: "/",
- plugins: [lucideIconsPlugin(), openapiPlugin()],
- },
-);
-
-export function getPageImage(page: InferPageType) {
- const segments = [...page.slugs, "image.webp"];
-
- return {
- segments,
- url: `/og/docs/${segments.join("/")}`,
- };
-}
-
-export async function getLLMText(page: InferPageType) {
- if (page.type === "openapi") {
- return JSON.stringify(page.data.getSchema().bundled, null, 2);
- }
-
- const processed = await page.data.getText("processed");
-
- return `# ${page.data.title}
-
-${processed}`;
-}
diff --git a/src/mdx-components.tsx b/src/mdx-components.tsx
deleted file mode 100644
index 269fc52..0000000
--- a/src/mdx-components.tsx
+++ /dev/null
@@ -1,13 +0,0 @@
-import * as TabsComponents from "fumadocs-ui/components/tabs";
-import defaultMdxComponents from "fumadocs-ui/mdx";
-import type { MDXComponents } from "mdx/types";
-import { APIPage } from "@/components/api-page";
-
-export function getMDXComponents(components?: MDXComponents): MDXComponents {
- return {
- ...defaultMdxComponents,
- ...TabsComponents,
- APIPage,
- ...components,
- };
-}
diff --git a/src/pages/404.astro b/src/pages/404.astro
new file mode 100644
index 0000000..e757a2f
--- /dev/null
+++ b/src/pages/404.astro
@@ -0,0 +1,67 @@
+---
+import ArrowLeft from "@lucide/astro/icons/arrow-left";
+import House from "@lucide/astro/icons/house";
+import StarlightPage from "@astrojs/starlight/components/StarlightPage.astro";
+---
+
+
+
+
+
Error 404
+
+ Page not found
+
+
+ The page you're looking for doesn't exist or has been moved to a different URL.
+