- 03 Apr 2024
- 5 Minutes to read
- PDF
Domains and Services
- Updated on 03 Apr 2024
- 5 Minutes to read
- PDF
Traceable discovers domains and services based on the traffic it sees through the system. It uses the span data, such as API headers, attributes, etc. to discover domains and services. Traceable does not display any services through which there is no data flow. Such services are called inactive services. These domains and services are listed based on your chosen environment from the top menu bar.
Domains
Traceable's Domains page lists all the domains that it has discovered. At a high level, the page displays:
P99 latency for the domain
The average latency
Total number of errors and errors per second
Total number of calls and calls per second
Note
By default, the Domains page lists all the external domains. However, you can click on External: True and select the appropriate value to view the external or internal domains according to your requirements.
You can click on the domain name to view the detailed information for each domain. The following details about each domain are displayed:
Overview
Endpoints
Events
Traces
Metrics
Overview
The Overview tab displays the various performance numbers for the domain, such as latency numbers, errors per second, etc. These numbers are displayed for the time period that you choose from the top menu.
The Overview page also displays the top Endpoints related to that domain. These endpoints can be sorted based on the number of calls or different latency numbers.
Endpoints
The Endpoints tab displays rich information for all the endpoints for your chosen domain. A single domain can have multiple endpoints connected to it. The tab also displays information like risk and threat index for an individual endpoint.
You can filter the domains based on:
Statuses — You can filter on New or Updated APIs.
Labels — You can filter based on the Labels you applied to an API endpoint. For more information, see Label management.
Risk — You can filter based on the type of risk that the API endpoint has, for example, low, medium, high, or critical risk. Traceable identifies the risk using its algorithms. For more information, see Risk Score.
Sensitive Data — You can filter the APIs based on the sensitive data they carry. This sensitive data is either marked by you or identified by Traceable. For more information, see Sensitive data.
You can also click on the Settings () icon to filter endpoints based on certain pre-defined parameters.
Events
The Events tab lists all the events related to that domain. The tab displays the type of event, for example, value out range, conditional SQL injection attempts, Authorization Bypass - object level, etc. The corresponding API for each event is also displayed. You can click on the event to view detailed information about it.
If you believe that a type of event should not be reported for an API, you can exclude such an event from reporting. For more information on events and custom exclusions, see Active events.
Traces
The Traces tab provides rich and deep information about the spans in each request for the Endpoint. The tab displays:
Protocol
Endpoint
URL
Status
Duration of request and response
Start time
Filter traces
You can filter the traces based on different types of pre-defined filters available, such as, calls, duration, Edge API ID, etc. To filter and narrow down the search, click on the filter bar, as shown in the screenshot above, and choose a filter. For example, you can choose Duration and then press the space bar on your keyboard to display various filter options.
Metrics
The Metrics tab provides detailed information related to the domain's performance, such as latency numbers. When you hover the mouse over the latency graph, Traceable displays the request latency number for that time. These latency numbers are for:
P99 latency
P95 latency
P50 latency
Average latency
The tab also displays the error rate and error percentage along with calls per minute and data transfer in B/s. All metrics are displayed by default for the last 5 minutes.
Services
The Services section of Traceable displays all the active services in your system. At a high level, the page displays:
P99 latency
Average latency
Total number of errors on the service and errors per second
Total number of calls on the service and calls per second
The above values are displayed for the time period that you chose from the top menu bar.
You can click on the Service name to view the detailed information for each service. The following details about each service are displayed:
Overview
Endpoints
Events
Traces
Metrics
Overview
The Overview tab displays the various performance numbers for the service, for example, P99 and P50 latency. The tab also displays errors/second and the total number of errors encountered in the time period chosen from the top menu bar.
The Overview tab also displays the Dependency graph. This graph displays the interconnect of services, the URL. When you hover the mouse over the interconnect of the services, it displays the communication latency between the two. If Traceable observes errors for any service, that service is shown in red color, and when you hover over that service, the interconnecting path shows the error percentage.
Endpoints
The Endpoints tab shows all the endpoints for the specific service. The tab displays the risk score and threat index for each endpoint related to the service. You can also view the latency number, information about errors, and the calls made to the API.
You can filter the domains based on:
Statuses — You can filter on New or Updated APIs.
Labels — You can filter based on the labels you applied to an API endpoint. For more information, see Label management.
Risk — You can filter based on the type of risk that the API endpoint has, for example, low, medium, high, or critical risk. The risk is identified by Traceable using its algorithms. For more information, see Risk Score.
Sensitive Data — You can filter the APIs based on the sensitive data they carry. This sensitive data is either marked by you or identified by Traceable. For more information, see Sensitive data.
You can also click on the Settings () icon to filter endpoints based on certain pre-defined parameters.
Malicious Behaviors
The Malicious Behaviors tab lists all the events related to that service. The tab displays the type of malicious event, for example, value out range, conditional SQL injection attempts, Authorization Bypass - object level, etc. The corresponding API for each behavior is also displayed. You can click on the behavior to view detailed information about it.
If you believe that a type of behavior should not be reported for an API, you can exclude it from reporting. For more information on malicious behaviors (events) and custom exclusions, see Active events.
Traces
The Traces tab provides rich and deep information about the spans in each request for the Endpoint. The tab displays:
Protocol
Endpoint
URL
Status
Duration of request and response
Start time
Filter traces
You can filter the traces based on different types of pre-defined filters available, such as calls, duration, Edge API ID, etc. To filter and narrow down the search, click on the filter bar, as shown in the screenshot above, and choose a filter. For example, you can choose Duration and then press the space bar on your keyboard to display various filter options.
Metrics
The Metrics tab provides detailed information related to the domain's performance, such as latency numbers. When you hover the mouse over the latency graph, Traceable displays the request latency number for that time. These latency numbers are for:
P99 latency
P95 latency
P50 latency
Average latency
The tab also displays error rate and error percentage, along with calls per minute and data transfer in B/s. All the metrics are displayed by default for the last 5 minutes.