Connections
Once you've installed the SDK, connected to the API endpoint, or integrated with OTel, you can now connect your Appear account to your environments.
Overview
Connections represent the relationship between Appear's introspector agent and your service. Every time you deploy Appear's agent into your codebases, a connection will be created.
Add a connection
To create a connection, follow these steps:
Log into your Appear account
Visit https://app.appear.sh/sign-in and sign in to Appear with your credentials
Create or select an environment
The first step is to create a new environment or select an existing one. If you have already installed and deployed the Appear introspector agent, there will be environment options to select from.
If you're creating a new environment, type in the name and click Create, then click Continue.

Read about branches and environments in our dedicated explainer page here.
Choose a framework
Browse the supported languages and frameworks for Appear's introspector agent and click on the one relevant for the codebase you're installing into.

Appear's product-map and installation guides express what languages and frameworks supported both current and planned.
Scope your API key
Give your API key a name, then scope it based on its use and expiry.
Scope it by choosing between:
Reporting only, or
Everything
Choose an expiry options:
30 days
60 days
90 days, or
No expiration

Once you're comfortable with the settings, click Save Settings, and then Continue.
Complete
The connection is now created. You can now view the connections or dive into your Catalog to watch the services appear once the introspector agent is installed and deployed or run locally.
View connections
Once you've created a connection you can view them in the Connections view. This page lists out all your active and inactive connections, which are specific to your environment.
Connection list
The connections you create through the Add connection process or from installing Appear's introspector agent will appear automatically in the Connections view.

Connections panel
You can view each connection in your list to see some extra detail which can be useful for understanding if the Appear agent is reporting as expected.

If you have any queries or require support with the above instructions, please get in touch with us.
Last updated
Was this helpful?