improve docs

Author: Ankcorn

README.md

@@ -1,7 +1,24 @@
 # Svelte Kit OpenTelemetry Middleware
+[![Documentation][docs_badge]][docs]
+[![Latest Release][release_badge]][release]
+[![License][license_badge]][license]
 
 A streamlined OpenTelemetry Middleware for SvelteKit
 
+![Svelte Trace](./trace.png)
+
+
+
+## Getting Started
+
+Install the packages
+
+```bash
+npm i @baselime/node-opentelemetry @baselime/sveltekit-opentelemetry-middleware
+```
+
+Add the following code to your `root.server.{ts|js}`
+
 ```javascript
 import { withOpenTelemetry } from '@baselime/sveltekit-opentelemetry-middleware'
 import { BaselimeSDK } from '@baselime/node-opentelemetry';
@@ -13,3 +30,30 @@ export const handle = withOpenTelemetry(async ({ event, resolve }) => {
 });
 ```
 
+To configure the BaselimeSDK visit the [documentation](https://baselime.io/docs/sending-data/languages/node.js/)
+
+## Options
+
+The withOpenTelemetry function takes the following options
+
+| Parameter             | Type      | Description                                              |
+|-----------------------|-----------|----------------------------------------------------------|
+| captureRequestBody    | boolean   | Capture the request body in the span. (Optional)         |
+| captureResponseBody   | boolean   | Capture the response body in the span. (Optional)        |
+| requestIdHeader       | string    | The header to look for the request id in. By default it will check x-request-id and x-vercel
+
+## License
+
+© Baselime Limited, 2023
+
+Distributed under MIT License (`The MIT License`).
+
+See [LICENSE](LICENSE) for more information.
+
+
+[docs]: https://baselime.io/docs/
+[docs_badge]: https://img.shields.io/badge/docs-reference-blue.svg?style=flat-square
+[release]: https://github.com/baselime/node-opentelemetry/releases/latest
+[release_badge]: https://img.shields.io/github/release/baselime/node-opentelemetry.svg?style=flat-square&ghcache=unused
+[license]: https://opensource.org/licenses/MIT
+[license_badge]: https://img.shields.io/github/license/baselime/node-opentelemetry.svg?color=blue&style=flat-square&ghcache=unused

example/package-lock.json

@@ -17,6 +17,7 @@
 	},
 	"type": "module",
 	"dependencies": {
-		"@baselime/node-opentelemetry": "^0.3.6"
+		"@baselime/node-opentelemetry": "^0.3.6",
+		"axios": "^1.6.7"
 	}
 }

example/package.json

@@ -1,11 +1,14 @@
 import type { Handle } from '@sveltejs/kit';
 import { withOpenTelemetry } from '../../src/index'
-import { BaselimeSDK } from '@baselime/node-opentelemetry';
+import { BaselimeSDK, BetterHttpInstrumentation } from '@baselime/node-opentelemetry';
 
 new BaselimeSDK({
     collectorUrl: 'https://otel.baselime.cc/v1',
     serverless: true,
-    service: "svelte-demo"
+    service: "svelte-demo",
+    instrumentations: [
+        new BetterHttpInstrumentation()
+    ]
 }).start();
 
 export const handle: Handle= withOpenTelemetry(async ({ event, resolve }) => {

example/src/hooks.server.ts

@@ -1,9 +1,11 @@
 import { fail } from '@sveltejs/kit';
 import { Game } from './game';
-
-export const load = ({ cookies }) => {
+import axios from 'axios';
+export const load = async ({ cookies }) => {
 	const game = new Game(cookies.get('sverdle'));
 
+	await axios.get('https://google.com')
+
 	return {
 		/**
 		 * The player's guessed words so far

example/src/routes/sverdle/+page.server.js

@@ -53,6 +53,7 @@
 		});
 	}
 
+
 	/**
 	 * Modify the game state without making a trip to the server,
 	 * if client-side JavaScript is enabled

example/src/routes/sverdle/+page.svelte

@@ -2,9 +2,11 @@ import type { Handle } from '@sveltejs/kit';
 import { trace, propagation, ROOT_CONTEXT } from '@opentelemetry/api';
 import { flatten } from 'flat';
 
+
 type TraceOptions = {
     captureRequestBody?: boolean;
     captureResponseBody?: boolean;
+    requestIdHeader?: string;
 }
 
 const possibleRequestIdHeaders = [
@@ -13,15 +15,24 @@ const possibleRequestIdHeaders = [
 ];
 
 
+/**
+ * 
+ * @param fn {Handle} The handle hook runs every time the SvelteKit server receives a request and determines the response. It receives an event object representing the request and a function called resolve, which renders the route and generates a Response. This allows you to modify response headers or bodies, or bypass SvelteKit entirely (for implementing routes programmatically, for example).
+ * @param opts.captureRequestBody {boolean} Capture the request body in the span.
+ * @param opts.captureResponseBody {boolean} Capture the response body in the span.
+ * @param opts.requestIdHeader {string} The header to look for the request id in. By default it will check x-request-id and x-vercel-id.
+ * @returns {Handle}
+ */
 export function withOpenTelemetry(fn: Handle, opts?: TraceOptions): Handle {
     opts = opts || {};
-    const tracer = trace.getTracer('svelte-kit');
+    const tracer = trace.getTracer('@baselime/sveltekit-opentelemetry-middleware');
     return async function (args) {
         const name = `${args.event.request.method} ${args.event.route.id}`;
-
-        const traceParent = propagation.extract(ROOT_CONTEXT, args.event.request.headers);
-
         let requestId: string | undefined = undefined;
+
+        if(opts.requestIdHeader) {
+            possibleRequestIdHeaders.push(opts.requestIdHeader.toLowerCase());
+        }
         for(const [key, value] of args.event.request.headers.entries()) {
             if(possibleRequestIdHeaders.includes(key.toLowerCase())) {
                 requestId = value;
@@ -54,7 +65,7 @@ export function withOpenTelemetry(fn: Handle, opts?: TraceOptions): Handle {
                     platform: args.event.platform
                 }
             })
-        }, traceParent, async (span) => {
+        }, async (span) => {
 
             const res = await fn(args);