-
Notifications
You must be signed in to change notification settings - Fork 949
Add reference / best practice for AWS + Azure infrastructure #1403
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
katmayb
wants to merge
5
commits into
main
Choose a base branch
from
self-hosted-aws-azure-options
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+280
−9
Open
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| --- | ||
| title: Self-hosted on AWS | ||
| sidebarTitle: AWS | ||
| icon: "aws" | ||
| --- | ||
|
|
||
| When running LangSmith on [Amazon Web Services (AWS)](https://aws.amazon.com/), you can set up in either [self-hosted](/langsmith/self-hosted) or [hybrid](/langsmith/hybrid) mode. In both cases, your workloads run on AWS infrastructure within your account, allowing you to use AWS managed services while maintaining control over your data and compute resources. | ||
|
|
||
| This page provides AWS-specific architecture patterns, service recommendations, and best practices for deploying and operating LangSmith on AWS. | ||
|
|
||
| <Note> | ||
| LangChain provides Terraform modules specifically for AWS to help provision infrastructure for LangSmith. These modules can quickly set up EKS clusters, RDS, ElastiCache, S3, and networking resources. | ||
|
|
||
| View the [AWS Terraform modules](https://github.com/langchain-ai/terraform/tree/main/modules/aws) for documentation and examples. | ||
| </Note> | ||
|
|
||
| ## Reference architecture | ||
|
|
||
| LangSmith on AWS leverages managed services to provide a scalable, secure, and resilient platform. The following architecture applies to both self-hosted and hybrid and aligns with the [AWS Well-Architected Framework](https://aws.amazon.com/architecture/well-architected/): | ||
|
|
||
|  | ||
|
|
||
| - <Icon icon="globe" /> **Ingress & networking**: Requests enter via [Amazon Application Load Balancer (ALB)](https://aws.amazon.com/elasticloadbalancing/application-load-balancer/) within your [VPC](https://aws.amazon.com/vpc/), secured using [AWS WAF](https://aws.amazon.com/waf/) and [IAM](https://aws.amazon.com/iam/)-based authentication. | ||
| - <Icon icon="cube" /> **Frontend & backend services:** Containers run on [Amazon EKS](https://aws.amazon.com/eks/), orchestrated behind the ALB. Nginx routes requests to the LangSmith frontend, backend, and queue workers. | ||
| - <Icon icon="database" /> **Storage & databases:** | ||
| - [Amazon RDS for PostgreSQL](https://aws.amazon.com/rds/postgresql/): metadata, projects, users. | ||
| - [Amazon ElastiCache (Redis)](https://aws.amazon.com/elasticache/redis/): caching and job queues. | ||
| - ClickHouse + [Amazon EBS](https://aws.amazon.com/ebs/): analytics and trace storage. | ||
| - [Amazon S3](https://aws.amazon.com/s3/): object storage for trace artifacts and telemetry. | ||
| - <Icon icon="sparkles" /> **LLM integration:** Optionally proxy requests to [Amazon Bedrock](https://aws.amazon.com/bedrock/) or [Amazon SageMaker](https://aws.amazon.com/sagemaker/) for LLM inference. | ||
| - <Icon icon="chart-line" /> **Monitoring & observability:** Integrated with [Amazon CloudWatch](https://aws.amazon.com/cloudwatch/) and [LangSmith Beacon](/langsmith/self-host-egress) (for self-hosted telemetry opt-in). | ||
|
||
|
|
||
| ### LangSmith self-hosted models | ||
|
|
||
| You can host LangSmith on AWS using any of the three self-hosted models: | ||
|
|
||
| - [LangSmith Observability and Evaluation](/langsmith/self-hosted#self-host-langsmith-observability-and-evaluation): Deploy the UI and API services (frontend, backend, platform backend, playground, queue workers, and ACE). Use external AWS managed services for RDS PostgreSQL, ElastiCache, and S3. | ||
| - [Full LangSmith Platform Observability, Evaluation, and Agent Deployment](/langsmith/self-hosted#enable-langsmith-deployment): In addition to the application services, run the Agent Server [control plane](/langsmith/control-plane) and [data plane](/langsmith/data-plane) in your EKS cluster. The control plane is installed via Helm; the data plane consists of [Agent Server](/langsmith/agent-server) pods. | ||
| - [Standalone Agent Server](/langsmith/self-hosted/standalone-server): Deploy one or a few Agent Servers on EKS or Docker with external RDS PostgreSQL and ElastiCache. Use optional integration with the LangSmith UI for tracing. This model offers maximum flexibility and suits microservice architectures. | ||
| - [Hybrid](/langsmith/hybrid): Run your [data plane](/langsmith/data-plane) (Agent Servers and backing services) on AWS infrastructure while using LangChain's managed [control plane](/langsmith/control-plane) for the UI and APIs. The data plane uses the same AWS services (EKS, RDS PostgreSQL, ElastiCache) as the self-hosted models. | ||
|
|
||
| ## Compute options | ||
|
|
||
| LangSmith supports multiple compute options depending on your requirements: | ||
|
|
||
| | Compute option | Description | Suitable for | | ||
| |-----------------|-------------|--------------| | ||
| | **Elastic Kubernetes Service (preferred)** | Advanced scaling and multi-tenant support | Large enterprises | | ||
| | **EC2-based** | Full control, BYO-infra | Regulated or air-gapped environments | | ||
|
|
||
| ## AWS Well-Architected best practices | ||
|
|
||
| This reference is designed to align with the six pillars of the AWS Well-Architected Framework: | ||
|
|
||
| ### Operational excellence | ||
|
|
||
| - Automate deployments with IaC ([CloudFormation](https://aws.amazon.com/cloudformation/) / [Terraform](https://www.terraform.io/)). | ||
| - Use [AWS Systems Manager Parameter Store](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-parameter-store.html) for configuration. | ||
| - Continuously monitor via [CloudWatch Logs](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/WhatIsCloudWatchLogs.html) and LangSmith trace metrics. | ||
| - The preferred method to manage [LangSmith deployments](/langsmith/deployments) is to create a CI process that builds [Agent Server](/langsmith/agent-server) images and pushes them to [ECR](https://aws.amazon.com/ecr/). Create a test deployment for pull requests before deploying a new revision to staging or production upon PR merge. | ||
|
|
||
| ### Security | ||
|
|
||
| - Use [IAM](https://aws.amazon.com/iam/) roles with least-privilege policies. | ||
| - Enable encryption at rest ([RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Encryption.html), [S3](https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingEncryption.html), ClickHouse volumes) and in transit (TLS 1.2+). | ||
| - Integrate with [AWS Secrets Manager](https://aws.amazon.com/secrets-manager/) for credentials. | ||
| - Use [Amazon Cognito](https://aws.amazon.com/cognito/) as an IDP in conjunction with LangSmith's built-in authentication and authorization features to secure access to agents and their tools. | ||
|
|
||
| ### Reliability | ||
|
|
||
| - Replicate the LangSmith [data plane](/langsmith/data-plane) across regions: Deploy identical data planes to Kubernetes clusters in different regions for LangSmith Deployment. Deploy [RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.MultiAZSingleStandby.html) and [ECS](https://aws.amazon.com/ecs/) services across [Multi-AZ](https://aws.amazon.com/about-aws/global-infrastructure/regions_az/). | ||
| - Implement [auto-scaling](https://aws.amazon.com/autoscaling/) for backend workers. | ||
| - Use [Amazon Route 53](https://aws.amazon.com/route53/) health checks and failover policies. | ||
|
|
||
| ### Performance efficiency | ||
|
|
||
| - Leverage [AWS Graviton](https://aws.amazon.com/ec2/graviton/) instances for optimized compute. | ||
| - Cache hot datasets in [ElastiCache](https://aws.amazon.com/elasticache/). | ||
| - Use [S3 Intelligent-Tiering](https://aws.amazon.com/s3/storage-classes/intelligent-tiering/) for infrequently accessed trace data. | ||
|
|
||
| ### Cost optimization | ||
|
|
||
| - Right-size [EKS](https://aws.amazon.com/eks/) clusters using [Compute Savings Plans](https://aws.amazon.com/savingsplans/compute-pricing/). | ||
| - Adopt [Spot](https://aws.amazon.com/ec2/spot/) [Fargate](https://aws.amazon.com/fargate/) tasks for non-critical workloads. | ||
| - Monitor cost KPIs using [AWS Cost Explorer](https://aws.amazon.com/aws-cost-management/aws-cost-explorer/) dashboards. | ||
|
|
||
| ### Sustainability | ||
|
|
||
| - Minimize idle workloads with on-demand compute. | ||
| - Store telemetry in low-latency, low-cost tiers. | ||
| - Enable auto-shutdown for non-prod environments. | ||
|
|
||
| ## Security and compliance | ||
|
|
||
| LangSmith can be configured for: | ||
|
|
||
| - [PrivateLink](https://aws.amazon.com/privatelink/)-only access (no public internet exposure). | ||
| - [KMS](https://aws.amazon.com/kms/)-based encryption keys for S3, RDS, and EBS. | ||
| - Audit logging to [CloudWatch](https://aws.amazon.com/cloudwatch/) and [AWS CloudTrail](https://aws.amazon.com/cloudtrail/). | ||
|
|
||
| Customers can deploy in [GovCloud](https://aws.amazon.com/govcloud-us/), ISO, or HIPAA regions as needed. | ||
|
|
||
| ## Monitoring and evals | ||
|
|
||
| Use LangSmith to: | ||
|
|
||
| - Capture traces from LLM apps running on [Bedrock](https://aws.amazon.com/bedrock/) or [SageMaker](https://aws.amazon.com/sagemaker/). | ||
| - Evaluate model outputs via [LangSmith datasets](/langsmith/manage-datasets). | ||
| - Track latency, token usage, and success rates. | ||
|
|
||
| Integrate with: | ||
|
|
||
| - [AWS CloudWatch](https://aws.amazon.com/cloudwatch/) dashboards. | ||
| - [OpenTelemetry](https://opentelemetry.io/) and [Prometheus](https://prometheus.io/) exporters. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What does "LangSmith-managed agent" mean?