Skip to content

:hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error tracking, logs, and more – capture all the context agents need to diagnose problems, uncover opportunities, and ship fixes. Steer it all from Slack, web, desktop, or the MCP.

fix(logs): correct onboarding snippets (#120621)

Brittany Joiner9aa6ec8b5a67
diff --git a/docs/onboarding/logs/go.tsx b/docs/onboarding/logs/go.tsx
index dadaf6978627..773edf8d27f5 100644
--- a/docs/onboarding/logs/go.tsx
+++ b/docs/onboarding/logs/go.tsx
@@ -58,7 +58,7 @@ export const getGoSteps = (ctx: OnboardingComponentsContext): StepDefinition[] =
func setupLogging(ctx context.Context) (*sdklog.LoggerProvider, error) {
exporter, err := otlploghttp.New(ctx,
- otlploghttp.WithEndpointURL("<ph_client_api_host>/otlp/v1/logs"),
+ otlploghttp.WithEndpointURL("<ph_client_api_host>/i/v1/logs"),
otlploghttp.WithHeaders(map[string]string{
"Authorization": "Bearer <ph_project_token>",
}),
@@ -105,9 +105,9 @@ export const getGoSteps = (ctx: OnboardingComponentsContext): StepDefinition[] =
"context"
"log"
- "go.opentelemetry.io/otel/log/global"
- semconv "go.opentelemetry.io/otel/semconv/v1.26.0"
+ "go.opentelemetry.io/otel/attribute"
otellog "go.opentelemetry.io/otel/log"
+ "go.opentelemetry.io/otel/log/global"
)
func main() {
@@ -123,9 +123,9 @@ export const getGoSteps = (ctx: OnboardingComponentsContext): StepDefinition[] =
var record otellog.Record
record.SetSeverity(otellog.SeverityInfo)
- record.SetBody(otellog.StringValue("Application started"))
+ record.SetBody(attribute.StringValue("Application started"))
record.AddAttributes(
- otellog.Int64("server.port", 8080),
+ attribute.Int64("server.port", 8080),
)
logger.Emit(ctx, record)
}
diff --git a/docs/onboarding/logs/nextjs.tsx b/docs/onboarding/logs/nextjs.tsx
index b3be836165ac..3c50203ef01b 100644
--- a/docs/onboarding/logs/nextjs.tsx
+++ b/docs/onboarding/logs/nextjs.tsx
@@ -21,32 +21,38 @@ export const getNextJSSteps = (ctx: OnboardingComponentsContext): StepDefinition
language: 'bash',
file: 'npm',
code: dedent`
- npm install @opentelemetry/sdk-logs @opentelemetry/exporter-logs-otlp-http @opentelemetry/resources
+ npm install @opentelemetry/sdk-logs@latest @opentelemetry/exporter-logs-otlp-http@latest @opentelemetry/api@latest @opentelemetry/api-logs@latest @opentelemetry/resources@latest
`,
},
{
language: 'bash',
file: 'yarn',
code: dedent`
- yarn add @opentelemetry/sdk-logs @opentelemetry/exporter-logs-otlp-http @opentelemetry/resources
+ yarn add @opentelemetry/sdk-logs@latest @opentelemetry/exporter-logs-otlp-http@latest @opentelemetry/api@latest @opentelemetry/api-logs@latest @opentelemetry/resources@latest
`,
},
{
language: 'bash',
file: 'pnpm',
code: dedent`
- pnpm add @opentelemetry/sdk-logs @opentelemetry/exporter-logs-otlp-http @opentelemetry/resources
+ pnpm add @opentelemetry/sdk-logs@latest @opentelemetry/exporter-logs-otlp-http@latest @opentelemetry/api@latest @opentelemetry/api-logs@latest @opentelemetry/resources@latest
`,
},
{
language: 'bash',
file: 'bun',
code: dedent`
- bun add @opentelemetry/sdk-logs @opentelemetry/exporter-logs-otlp-http @opentelemetry/resources
+ bun add @opentelemetry/sdk-logs@latest @opentelemetry/exporter-logs-otlp-http@latest @opentelemetry/api@latest @opentelemetry/api-logs@latest @opentelemetry/resources@latest
`,
},
]}
/>
+ <Markdown>
+ These steps need `@opentelemetry/sdk-logs` 0.220.0 or later. The `@latest` tags upgrade any
+ older version already in your project. OpenTelemetry lists Node.js 18 (18.19 or later) and
+ Node.js 20.6 or later as supported for versions 0.220.0 through 0.222.0. Later releases may
+ change this.
+ </Markdown>
</>
),
},
@@ -74,7 +80,7 @@ export const getNextJSSteps = (ctx: OnboardingComponentsContext): StepDefinition
export function register() {
if (process.env.NEXT_RUNTIME === 'nodejs') {
const exporter = new OTLPLogExporter({
- url: '<ph_client_api_host>/otlp/v1/logs',
+ url: '<ph_client_api_host>/i/v1/logs',
headers: {
Authorization: 'Bearer <ph_project_token>',
},
@@ -84,10 +90,9 @@ export const getNextJSSteps = (ctx: OnboardingComponentsContext): StepDefinition
resource: resourceFromAttributes({
'service.name': 'my-nextjs-app',
}),
+ processors: [new SimpleLogRecordProcessor({ exporter })],
})
- loggerProvider.addLogRecordProcessor(new SimpleLogRecordProcessor(exporter))
-
// make the logger available globally
;(globalThis as any).__posthogLogger = loggerProvider.getLogger('my-nextjs-app')
}
@@ -98,18 +103,33 @@ export const getNextJSSteps = (ctx: OnboardingComponentsContext): StepDefinition
/>
<Markdown>
{dedent`
- Enable the instrumentation hook in \`next.config.ts\`:
+ On Next.js 13.2–14.x only, enable the instrumentation hook in your Next.js config. Skip this on Next.js 15 and later: \`instrumentation.ts\` is loaded by default, and \`experimental.instrumentationHook\` is no longer needed.
+
+ If you already have a config file, add \`instrumentationHook: true\` under \`experimental\` and keep your other settings. Use \`export default\` in \`next.config.mjs\`, or in \`next.config.js\` when your \`package.json\` has \`"type": "module"\`. Otherwise, use \`module.exports\`.
`}
</Markdown>
<CodeBlock
blocks={[
{
- language: 'typescript',
- file: 'next.config.ts',
+ language: 'javascript',
+ file: 'next.config.js',
code: dedent`
- import type { NextConfig } from 'next'
+ /** @type {import('next').NextConfig} */
+ const nextConfig = {
+ experimental: {
+ instrumentationHook: true,
+ },
+ }
- const nextConfig: NextConfig = {
+ module.exports = nextConfig
+ `,
+ },
+ {
+ language: 'javascript',
+ file: 'next.config.mjs',
+ code: dedent`
+ /** @type {import('next').NextConfig} */
+ const nextConfig = {
experimental: {
instrumentationHook: true,
},
@@ -137,6 +157,8 @@ export const getNextJSSteps = (ctx: OnboardingComponentsContext): StepDefinition
code: dedent`
import { SeverityNumber } from '@opentelemetry/api-logs'
+ export const dynamic = 'force-dynamic'
+
export async function GET() {
const logger = (globalThis as any).__posthogLogger
logger?.emit({
diff --git a/docs/onboarding/logs/nodejs.tsx b/docs/onboarding/logs/nodejs.tsx
index 7df56da3f633..693b2faadcff 100644
--- a/docs/onboarding/logs/nodejs.tsx
+++ b/docs/onboarding/logs/nodejs.tsx
@@ -21,32 +21,38 @@ export const getNodeJSSteps = (ctx: OnboardingComponentsContext): StepDefinition
language: 'bash',
file: 'npm',
code: dedent`
- npm install @opentelemetry/sdk-node @opentelemetry/sdk-logs @opentelemetry/exporter-logs-otlp-http @opentelemetry/resources
+ npm install @opentelemetry/sdk-node@latest @opentelemetry/sdk-logs@latest @opentelemetry/exporter-logs-otlp-http@latest @opentelemetry/api@latest @opentelemetry/api-logs@latest @opentelemetry/resources@latest
`,
},
{
language: 'bash',
file: 'yarn',
code: dedent`
- yarn add @opentelemetry/sdk-node @opentelemetry/sdk-logs @opentelemetry/exporter-logs-otlp-http @opentelemetry/resources
+ yarn add @opentelemetry/sdk-node@latest @opentelemetry/sdk-logs@latest @opentelemetry/exporter-logs-otlp-http@latest @opentelemetry/api@latest @opentelemetry/api-logs@latest @opentelemetry/resources@latest
`,
},
{
language: 'bash',
file: 'pnpm',
code: dedent`
- pnpm add @opentelemetry/sdk-node @opentelemetry/sdk-logs @opentelemetry/exporter-logs-otlp-http @opentelemetry/resources
+ pnpm add @opentelemetry/sdk-node@latest @opentelemetry/sdk-logs@latest @opentelemetry/exporter-logs-otlp-http@latest @opentelemetry/api@latest @opentelemetry/api-logs@latest @opentelemetry/resources@latest
`,
},
{
language: 'bash',
file: 'bun',
code: dedent`
- bun add @opentelemetry/sdk-node @opentelemetry/sdk-logs @opentelemetry/exporter-logs-otlp-http @opentelemetry/resources
+ bun add @opentelemetry/sdk-node@latest @opentelemetry/sdk-logs@latest @opentelemetry/exporter-logs-otlp-http@latest @opentelemetry/api@latest @opentelemetry/api-logs@latest @opentelemetry/resources@latest
`,
},
]}
/>
+ <Markdown>
+ These steps need `@opentelemetry/sdk-logs` 0.220.0 or later. The `@latest` tags upgrade any
+ older version already in your project. OpenTelemetry lists Node.js 18 (18.19 or later) and
+ Node.js 20.6 or later as supported for versions 0.220.0 through 0.222.0. Later releases may
+ change this.
+ </Markdown>
</>
),
},
@@ -72,7 +78,7 @@ export const getNodeJSSteps = (ctx: OnboardingComponentsContext): StepDefinition
import { LoggerProvider, SimpleLogRecordProcessor } from '@opentelemetry/sdk-logs'
const exporter = new OTLPLogExporter({
- url: '<ph_client_api_host>/otlp/v1/logs',
+ url: '<ph_client_api_host>/i/v1/logs',
headers: {
Authorization: 'Bearer <ph_project_token>',
},
@@ -82,10 +88,9 @@ export const getNodeJSSteps = (ctx: OnboardingComponentsContext): StepDefinition
resource: resourceFromAttributes({
'service.name': 'my-app',
}),
+ processors: [new SimpleLogRecordProcessor({ exporter })],
})
- loggerProvider.addLogRecordProcessor(new SimpleLogRecordProcessor(exporter))
-
export const logger = loggerProvider.getLogger('my-app')
`,
},
diff --git a/docs/onboarding/logs/opentelemetry.tsx b/docs/onboarding/logs/opentelemetry.tsx
index 76459a908b81..f8511338d777 100644
--- a/docs/onboarding/logs/opentelemetry.tsx
+++ b/docs/onboarding/logs/opentelemetry.tsx
@@ -26,7 +26,7 @@ export const getOpenTelemetrySteps = (ctx: OnboardingComponentsContext): StepDef
language: 'bash',
file: 'Environment variables',
code: dedent`
- OTEL_EXPORTER_OTLP_LOGS_ENDPOINT="<ph_client_api_host>/otlp/v1/logs"
+ OTEL_EXPORTER_OTLP_LOGS_ENDPOINT="<ph_client_api_host>/i/v1/logs"
OTEL_EXPORTER_OTLP_LOGS_HEADERS="Authorization=Bearer <ph_project_token>"
OTEL_SERVICE_NAME="my-app"
`,
@@ -46,7 +46,7 @@ export const getOpenTelemetrySteps = (ctx: OnboardingComponentsContext): StepDef
exporters:
otlphttp/posthog:
- logs_endpoint: "<ph_client_api_host>/otlp/v1/logs"
+ logs_endpoint: "<ph_client_api_host>/i/v1/logs"
headers:
Authorization: "Bearer <ph_project_token>"
diff --git a/docs/onboarding/logs/python.tsx b/docs/onboarding/logs/python.tsx
index 5e0968ab1f6a..03f18004ddfb 100644
--- a/docs/onboarding/logs/python.tsx
+++ b/docs/onboarding/logs/python.tsx
@@ -53,7 +53,7 @@ export const getPythonSteps = (ctx: OnboardingComponentsContext): StepDefinition
set_logger_provider(logger_provider)
exporter = OTLPLogExporter(
- endpoint="<ph_client_api_host>/otlp/v1/logs",
+ endpoint="<ph_client_api_host>/i/v1/logs",
headers={"Authorization": "Bearer <ph_project_token>"},
)
logger_provider.add_log_record_processor(BatchLogRecordProcessor(exporter))