From 4a15efe9e7e45ce3e51ddf2d5aeee8c3ccc2ccdf Mon Sep 17 00:00:00 2001 From: sayonfortify Date: Mon, 22 Jun 2026 19:16:04 +0530 Subject: [PATCH] docs(readme): use real fr_sk_ API key format in all examples README examples used api_key="fr-xxx", which is not the format the platform mints or accepts. Real keys are fr_sk_ (generated by GenerateAPIKey and validated by the ingestion auth prefix check), so the documented placeholder taught a value the backend would reject. - Replace all 6 api_key="fr-xxx" occurrences with "fr_sk_..." - Mirror the app Getting Started quickstart: add an app_name comment and resource_attributes={"environment": "dev"} so the two canonical quickstarts are identical --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 0e6fd94..f6e30d5 100644 --- a/README.md +++ b/README.md @@ -23,8 +23,9 @@ pip install "fortifyroot-ocelle[openai,anthropic,langchain]" import fortifyroot.ocelle as ocelle ocelle.init( - app_name="my-llm-app", - api_key="fr-xxx", + app_name="my-llm-app", # any name you choose for this service + api_key="fr_sk_...", + resource_attributes={"environment": "dev"}, # dev / prod / testing — or any label you choose ) import openai @@ -89,7 +90,7 @@ from fortifyroot.ocelle import Instruments ocelle.init( app_name="my-llm-app", - api_key="fr-xxx", + api_key="fr_sk_...", api_endpoint="https://api.fortifyroot.com", trace_content=True, instruments={Instruments.OPENAI, Instruments.LANGCHAIN}, @@ -104,7 +105,7 @@ from opentelemetry.sdk.trace.sampling import TraceIdRatioBased ocelle.configure() \ .app_name("my-llm-app") \ - .api_key("fr-xxx") \ + .api_key("fr_sk_...") \ .trace_content(False) \ .sampler(TraceIdRatioBased(0.1)) \ .init() @@ -119,7 +120,7 @@ from opentelemetry.sdk.trace.sampling import TraceIdRatioBased ocelle.init( app_name="my-app", - api_key="fr-xxx", + api_key="fr_sk_...", sampler=TraceIdRatioBased(0.1), ) @@ -134,7 +135,7 @@ def span_callback(span): ocelle.init( app_name="my-app", - api_key="fr-xxx", + api_key="fr_sk_...", span_postprocess_callback=span_callback, ) ``` @@ -172,7 +173,7 @@ Attach custom properties to traces for filtering and correlation: ```python import fortifyroot.ocelle as ocelle -ocelle.init(app_name="my-app", api_key="fr-xxx") +ocelle.init(app_name="my-app", api_key="fr_sk_...") ocelle.set_association_properties({ "user_id": "user_12345", @@ -196,7 +197,7 @@ import fortifyroot.ocelle as ocelle ocelle.init( app_name="my-app", - api_key="fr-xxx", + api_key="fr_sk_...", trace_content=False, ) ```