From 150753bbcd54454ad51f180d61f9d2954e9623c0 Mon Sep 17 00:00:00 2001 From: infra Date: Mon, 6 Jan 2025 22:19:32 -0300 Subject: [PATCH] fmt --- docs/self_hosting/egress.mdx | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/self_hosting/egress.mdx b/docs/self_hosting/egress.mdx index 4d33dd96..65dec022 100644 --- a/docs/self_hosting/egress.mdx +++ b/docs/self_hosting/egress.mdx @@ -8,10 +8,10 @@ sidebar_position: 7 By default, Self-Hosted LangSmith instances store all information locally and will never send sensitive information outside your network. However, we do require egress to `https://beacon.langchain.com` for two reasons: 1. Subscription Metrics: - - Metrics used to determine Customer's access and use of the Licensed Platform, including but not limited to, the number of Traces, number of Users, number of Nodes Executed, or other mutually agreed criteria as set out in an Order Form. - - This includes license verification and usage reporting. + - Metrics used to determine Customer's access and use of the Licensed Platform, including but not limited to, the number of Traces, number of Users, number of Nodes Executed, or other mutually agreed criteria as set out in an Order Form. + - This includes license verification and usage reporting. 2. Operational Metadata - - Operational Metadata means usage information generated by the Licensed Platform and collected by LangChain for the purposes of delivering an optimal implementation of the Licensed Platform. Operational Metadata may include information such as type and version of the LangChain software, operating system version and environment type of Customer's Infrastructure, uptime and availability, system error logs and health metrics, product feature usage, general integrity and security of the Licensed Platform. For the avoidance of doubt, Operational Metadata will never include Customer Data, AI Content, or Customer Confidential Information. + - Operational Metadata means usage information generated by the Licensed Platform and collected by LangChain for the purposes of delivering an optimal implementation of the Licensed Platform. Operational Metadata may include information such as type and version of the LangChain software, operating system version and environment type of Customer's Infrastructure, uptime and availability, system error logs and health metrics, product feature usage, general integrity and security of the Licensed Platform. For the avoidance of doubt, Operational Metadata will never include Customer Data, AI Content, or Customer Confidential Information. This will require egress to `https://beacon.langchain.com` from your network. @@ -20,12 +20,15 @@ This will require egress to `https://beacon.langchain.com` from your network. ### License Verification POST beacon.langchain.com/v1/beacon/verify + ```json { "license: "" } ``` + Response: + ```json { "token": "Valid JWT" //Short-lived JWT token to avoid repeated license checks @@ -36,6 +39,7 @@ Response: POST beacon.langchain.com/v1/beacon/ingest-traces Example request payload: + ```json { "license": "", @@ -59,6 +63,7 @@ Example request payload: ``` Example response payload: + ```json { "inserted_count": 1 // Number of transactions successfully ingested