This getting started guide is designed to help you start using the FireTail SaaS platform. View comprehensive documentation and explore all the functionalities of the FireTail platform by selecting from the documentation categories.
The steps detailed below are the suggested order of your initial setup on the FireTail platform, however, steps 1-4 should be completed first to enable a smooth set up of the rest of the platform.
To get started, you need to set up an account to sign in to the FireTail platform. To do this:
Follow the on-screen instructions to complete the sign-up process. To learn more, go to How do I set up an account.
When you have an account set up the next thing you need to do is create an organisation.
Adding an organisation enables you to Add members and set up the Applications, APIs, Integrations and Alerts within that organisation. You can create multiple organisations if needed. Each organisation exists separately on the platform, nothing is shared between them. For instance, when a member is added it is only added to that organisation, if that member needs access to a different organisation they need to be added to that. When you first sign up to the FireTail platform, you are prompted to create an organisation. You can also create organisations using the dropdown menu in the FireTail platform.
When you create an organisation you must select what subscription you want to avail of, this includes a free 7 day trial of the business subscription.
Learn more:
With an organisation created, you can now populate the platform with API information. The first step to this is to create an application, this is step necessary to do as when you discover APIs or create APIs these are added to an application.
Learn more about applications here.
Set up an integration to get full visibility of your APIs. You can create an integration with AWS, Azure and GitHub.
Learn more:
Creating a notification integration enables you to receive notifications when an alert is triggered. You should set up the integration before creating the alert as you need to select which notification service you want to receive the alert to.
Learn more:
The alerting functionality of FireTail's platform enables you to set defined filters, conditions, and thresholds that when reached will trigger an alert. When creating the alert you select the notification method, then if the threshold and conditions are met you will receive a notification to your selected notification.
Learn how to Create an alert here.
Create an integration with AWS logging. Your logs will be ingested into the platform. You can view logs in the log table of the dashboard.
Learn more:
Collections can be used to group information for an API. Creating a collection on the platform allows you to view the inventory data. You can upload a collection as a JSON or YAML file. Collections are uploaded to an API.
Learn more about collections here.
