Instana Quick Start Guide
This guide helps you get started with Instana's Application Performance Monitoring (APM) platform quickly.
Welcome to Instana! This comprehensive quick start guide will walk you through the essential steps to begin monitoring your applications and infrastructure.
What is Instana?
Instana is an enterprise observability and automated application performance management (APM) solution that provides:
- Automatic discovery of your application infrastructure
- Real-time monitoring with 1-second granularity
- Distributed tracing across microservices
- AI-powered root cause analysis
- Full-stack visibility from infrastructure to application code
For more information, see Application Monitoring and Infrastructure Monitoring.
Prerequisites
Before you begin, ensure you have:
- Access to your Instana tenant URL (for example,
https://your-tenant.instana.io) - Your Instana agent key (provided by your admin)
- Appropriate permissions to install agents on your infrastructure
Step 1: Access Instana Dashboard
- Navigate to your Instana tenant URL
- Log in with your credentials
- Familiarize yourself with the main navigation:
- Infrastructure - View all monitored hosts and containers
- Applications - Monitor application services and endpoints
- Websites - Track end-user experience
- Events - View incidents and changes
- Analytics - Create custom dashboards and queries
Step 2: Install the Instana Agent
The Instana agent automatically discovers and monitors your applications. Choose your installation method based on your infrastructure.
For Linux/Unix Hosts
curl -o setup_agent.sh https://setup.instana.io/agent && chmod 700 ./setup_agent.sh && sudo ./setup_agent.sh -a <agent_key> -t dynamic -e <backend_url>
For Kubernetes
kubectl create namespace instana-agent
kubectl create secret generic instana-agent-secret \
--from-literal=key=<agent_key> \
--namespace=instana-agent
helm repo add instana https://agents.instana.io/helm
helm install instana-agent instana/instana-agent \
--namespace instana-agent \
--set agent.key=<agent_key> \
--set agent.endpointHost=<backend_url>
For Docker
docker run -d --name instana-agent \
--privileged --net=host --pid=host \
-v /var/run/docker.sock:/var/run/docker.sock \
-v /dev:/dev -v /sys:/sys -v /var/log:/var/log \
-e INSTANA_AGENT_KEY=<agent_key> \
-e INSTANA_AGENT_ENDPOINT=<backend_url> \
icr.io/instana/agent
<agent_key> and <backend_url> with your actual values.Step 3: Verify Agent Installation
- Go to Infrastructure → Agents in the Instana UI
- Wait 1-2 minutes for your agent to appear
- Verify the agent status shows as "Healthy" (green)
- Check that discovered technologies are listed
Step 4: Explore Your Infrastructure
For more information, see Infrastructure Monitoring.
- Navigate to Infrastructure → Map
- View the automatic discovery of:
- Hosts and containers
- Applications and services
- Databases and message queues
- Network connections
- Click on any component to see detailed metrics
Step 5: Monitor Your Applications
For more information, see Application Monitoring.
View Application Services
- Go to Applications → Services
- See all automatically discovered services
- Click on a service to view:
- Request rate and latency
- Error rates
- Dependencies
- Endpoints
Analyze Traces
- Navigate to Applications → Calls
- View distributed traces across your microservices
- Click on any trace to see:
- Complete request flow
- Timing breakdown
- Errors and exceptions
- Database queries
Step 6: Set Up Alerts
For more information, see Alerting.
Create a Smart Alert
- Go to Events → Alerts
- Click + New Alert
- Choose alert type:
- Built-in Events - Pre-configured alerts for common issues
- Threshold - Alert on metric thresholds
- Smart Alerts - AI-powered anomaly detection
- Configure scope (which services/infrastructure)
- Set notification channels (email, Slack, PagerDuty, etc.)
- Save and activate
Example: High Error Rate Alert
- Alert Type: Threshold
- Metric: Error Rate
- Condition: > 5%
- Duration: 5 minutes
- Scope: All services in production
Step 7: Create Your First Dashboard
For more information, see Building Custom Dashboards.
- Navigate to Analytics → Dashboards
- Click + Create Dashboard
- Add widgets:
- Metrics - Time series charts
- Service List - Table of services
- Infrastructure Map - Visual topology
- Log Messages - Recent logs
- Customize time range and filters
- Save and share with your team
Step 8: Investigate Issues
For more information, see Root Cause Analysis.
When an Incident Occurs
- Go to Events → Incidents
- Click on the incident to see:
- Root Cause - AI-identified source of the problem
- Impact - Affected services and users
- Timeline - Sequence of events
- Related Changes - Recent deployments or config changes
- Click Analyze to dive deeper
- Use Unbounded Analytics to query raw data
Troubleshooting Workflow
Follow this workflow when investigating incidents:
- Incident Alert
- View Root Cause
- Check Traces
- Analyze Logs
- Review Changes
- Identify Fix
- Resolve
Key Features to Explore
After completing the initial setup, explore these advanced features:
Unbounded Analytics
- Query any metric or trace data
- No sampling, full data retention
- Custom visualizations
- Path: Analytics → Unbounded Analytics
Service Level Objectives (SLOs)
- Define and track SLOs
- Monitor error budgets
- Path: Applications → SLOs
For more information, see Getting Started with Service Level Objectives.
Website Monitoring
- Real user monitoring (RUM)
- Track page load times
- Monitor JavaScript errors
- Path: Websites
Log Management
- Centralized log collection
- Correlation with traces
- Smart log alerts
- Path: Analytics → Logs
For more information, see Logging.
Common Tasks Cheat Sheet
| Task | Navigation Path |
|---|---|
| View all services | Applications → Services |
| See infrastructure map | Infrastructure → Map |
| Check agent health | Infrastructure → Agents |
| View recent incidents | Events → Incidents |
| Create dashboard | Analytics → Dashboards |
| Query metrics | Analytics → Unbounded Analytics |
| Configure alerts | Events → Alerts |
| View traces | Applications → Calls |
| Check logs | Analytics → Logs |
| Set up SLOs | Applications → SLOs |
Best Practices
- Tag Your Services
- Use consistent naming conventions
- Add environment tags (prod, staging, dev)
- Tag by team ownership
- Set Up Meaningful Alerts
- Start with built-in events
- Avoid alert fatigue - be selective
- Use Smart Alerts for anomaly detection
- Create Team Dashboards
- One dashboard per service/team
- Include key metrics: latency, errors, throughput
- Add SLO widgets
- Regular Reviews
- Weekly: Review incidents and trends
- Monthly: Optimize alert thresholds
- Quarterly: Review SLO compliance
Next Steps
Now that you are set up, consider:
- Instrument Custom Code
- Add manual spans for business logic
- Track custom metrics
- Integrate with OpenTelemetry
- Integrate with CI/CD
- Track deployments as change events
- Monitor release impact
- Set up quality gates
- Expand Monitoring
- Add more environments
- Enable website monitoring
- Configure synthetic monitoring
- Optimize Alerts
- Fine-tune thresholds based on baselines
- Set up escalation policies
- Integrate with incident management tools
Quick Reference: Key Concepts
- Agent: Software that collects monitoring data from your infrastructure
- Sensor: Component that monitors specific technologies (Java, Node.js, etc.)
- Service: A logical grouping of endpoints (for example, user-service, payment-api)
- Call: A single request through your distributed system
- Trace: Complete path of a request across all services
- Span: Individual operation within a trace
- Incident: Detected issue requiring attention
- Event: Any change or occurrence in your system
Troubleshooting Common Issues
Agent Not Appearing
- Check network connectivity to backend
- Verify agent key is correct
- Review agent logs:
/opt/instana/agent/data/log/agent.log
No Data for Application
- Ensure application is running
- Check if technology is supported
- Verify agent has necessary permissions
Missing Traces
- Check if tracing is enabled for the service
- Verify network connectivity between services
- Review trace sampling configuration
Getting Help
Documentation
- Official Docs: IBM Instana Observability
- API Reference: Available in your Instana UI under Settings → API
Support Channels
- In-App Chat: Click the help icon in Instana UI
- Support Portal: Contact your admin for access
- Community: Instana community forums
Learning Resources
- Instana University: Free training courses
- Webinars: Regular product updates
- Blog: Best practices and use cases