LogicMonitor
LogicMonitor is a SaaS-based monitoring platform designed for automated monitoring of IT systems. It centralizes monitoring by providing a unified view of various IT components, including networks, cloud environments, servers, and applications.
It features automated monitoring and provides data insights.
LogicMonitor utilizes the LogicMonitor Collector for data collection, an installed Java application that runs on either Linux or Windows servers. Collected data is stored in a centralized data center.
Nobl9 integration with LogicMonitor allows you to create SLOs on LogicMonitor DataPoints based on a threshold (raw) or ratio (count) metrics.
LogicMonitor parameters and supported features in Nobl9
- General support:
- Release channel: Beta
- Connection method: Agent, Direct
- Replay and SLI Analyzer: Supported
- Event logs: Supported
- Query checker: Not supported
- Query parameters retrieval: Supported
- Timestamp cache persistence: Supported
- Query parameters:
- Query interval: 1 min
- Query delay: 2 min
- Jitter: 15 sec
- Timeout: 30 sec
- Agent details and minimum required versions for supported features:
- Environment variable:
LOGIC_MONITOR_QUERY_DELAY
- Plugin name:
n9logic_monitor
- Replay and SLI Analyzer:
0.81.0-beta
- Maximum historical data retrieval period:
30 days
- Query parameters retrieval:
0.76.0-beta
- Timestamp cache persistence:
0.76.0-beta
- Additional notes:
- Bad over total ratio metric
Users can add LogicMonitor as a data source and create threshold and ratio SLOs against LogicMonitor in the following ways:
- Nobl9 Web wizardsβthe direct and agent connection methods, and SLOs
sloctl
βthe direct and agent connection methods, and SLOs- The Nobl9 Terraform Providerβthe direct and agent connection methods, and SLOs
Prerequisitesβ
Authentication to LogicMonitor requires an LMv1 token credentialsβaccessID
and accessKey
βissued for your LogicMonitor account.
For the direct connection method,
you're additionally required to provide accessID
and accessKey
, along with your LogicMonitor account.
For the agent connection method, you need to provide your LogicMonitor account only.
You pass these credentials using the environment variables when deploying the agent.
More about creating LMv1 tokens in LogicMonitor.
More about signing API calls to LogicMonitor.
To ensure data transmission between Nobl9 and LogicMonitor,
it may be necessary to list Nobl9 IP addresses as trusted.
app.nobl9.com
instance:- 18.159.114.21
- 18.158.132.186
- 3.64.154.26
us1.nobl9.com
instance:- 34.121.54.120
- 34.123.193.191
- 34.134.71.10
- 35.192.105.150
- 35.225.248.37
- 35.226.78.175
- 104.198.44.161
Adding LogicMonitor as a data sourceβ
Select the preferable way to add LogicMonitor as a data source. Once added, your LogicMonitor data source becomes available on the Nobl9 Web > Integrations data source list.
Direct connection methodβ
Nobl9 Webβ
- Navigate to Integrations > Sources.
- Click .
- Click the required Source button.
- Choose Direct.
- Enter your LogicMonitor Account.
- Provide your Access ID and Access Keyβyour LMv1 token credentials issued for your LogicMonitor account.
Learn more about creating LMv1 tokens in LogicMonitor and signing API calls to LogicMonitor.
- Select a Project.
Specifying a project is helpful when multiple users are spread across multiple teams or projects. When the Project field is left blank, Nobl9 uses thedefault
project. - Enter a Display Name.
You can enter a user-friendly name with spaces in this field. - Enter a Name.
The name is mandatory and can only contain lowercase, alphanumeric characters, and dashes (for example,my-project-1
). Nobl9 duplicates the display name here, transforming it into the supported format, but you can edit the result. - Enter a Description.
Here you can add details such as who is responsible for the integration (team/owner) and the purpose of creating it. - Specify the Query delay to set a customized delay for queries when pulling the data from the data source.
- The default value in LogicMonitor integration for Query delay is
2 minutes
.
infoChanging the Query delay may affect your SLI data. For more details, check the Query delay documentation. - The default value in LogicMonitor integration for Query delay is
- Enter a Maximum Period for Historical Data Retrieval.
- This value defines how far back in the past your data will be retrieved when replaying your SLO based on this data source.
- The maximum period value depends on the data source.
Find the maximum value for your data source. - A greater period can extend the loading time when creating an SLO.
- The value must be a positive integer.
- Enter a Default Period for Historical Data Retrieval.
- It is used by SLOs connected to this data source.
- The value must be a positive integer or
0
. - By default, this value is set to 0. When you set it to
>0
, you will create SLOs with Replay.
- Click Add Data Source
sloctlβ
To connect the LogicMonitor data source using the direct method,
apply the following configuration using the sloctl apply -f
command:
apiVersion: n9/v1alpha
kind: Direct
metadata:
# String, mandatory a-z, 0-9, and "-" only. The data source name identifier
name: my-logic-monitor-data-source
# String, optional. The data source user-friendly name
displayName: My LogicMonitor data source
# String, mandatory. The name identifier of the project to locate your data source in
project: my-project
spec:
# String, optional
description: Sample LogicMonitor data source (agent connection)
# Mandatory. Currently, beta for LogicMonitor
releaseChannel: beta
# Source-specific fields
logicMonitor:
# String, mandatory. Replace with your LogicMonitor account
account: my-account-name
# String, mandatory. Replace with your LogicMonitor accessID
accessId: REDACTED
# String, mandatory. Replace with your LogicMonitor accessKey
accessKey: REDACTED
# Mandatory. The query delay configuration
queryDelay:
value: 3
unit: Minute
historicalDataRetrieval:
maxDuration:
value: 30
unit: Day
defaultDuration:
value: 15
unit: Day
Field | Type | Description |
---|---|---|
queryDelay.unit mandatory | enum | Specifies the unit for the query delay. Possible values: Second | Minute . β’ Check query delay documentation for default unit of query delay for each source. |
queryDelay.value mandatory | numeric | Specifies the value for the query delay. β’ Must be a number less than 1440 minutes (24 hours). β’ Check query delay documentation for default unit of query delay for each source. |
releaseChannel mandatory | enum | Specifies the release channel. Accepted values: beta | stable . |
Source-specific fields | ||
logicMonitor.account mandatory | string | Your LogicMonitor account. |
logicMonitor.accessID mandatory | string, secret | Your LogicMonitor access ID. |
logicMonitor.accessKey mandatory | string, secret | Your LogicMonitor access key. |
You can directly apply the YAML or save the configuration as a YAML file
and pass it with the sloctl apply -f %path-to-your-file.yaml%
command.
Agent connection methodβ
Nobl9 Webβ
- Navigate to Integrations > Sources.
- Click .
- Click the required Source button.
- Choose Agent.
- Provide your LogicMonitor Account.
- Select a Project.
Specifying a project is helpful when multiple users are spread across multiple teams or projects. When the Project field is left blank, Nobl9 uses thedefault
project. - Enter a Display Name.
You can enter a user-friendly name with spaces in this field. - Enter a Name.
The name is mandatory and can only contain lowercase, alphanumeric characters, and dashes (for example,my-project-1
). Nobl9 duplicates the display name here, transforming it into the supported format, but you can edit the result. - Enter a Description.
Here you can add details such as who is responsible for the integration (team/owner) and the purpose of creating it. - Specify the Query delay to set a customized delay for queries when pulling the data from the data source.
- The default value in LogicMonitor integration for Query delay is
2 minutes
.
infoChanging the Query delay may affect your SLI data. For more details, check the Query delay documentation. - The default value in LogicMonitor integration for Query delay is
- Enter a Maximum Period for Historical Data Retrieval.
- This value defines how far back in the past your data will be retrieved when replaying your SLO based on this data source.
- The maximum period value depends on the data source.
Find the maximum value for your data source. - A greater period can extend the loading time when creating an SLO.
- The value must be a positive integer.
- Enter a Default Period for Historical Data Retrieval.
- It is used by SLOs connected to this data source.
- The value must be a positive integer or
0
. - By default, this value is set to 0. When you set it to
>0
, you will create SLOs with Replay.
- Click Add Data Source
sloctlβ
To connect the LogicMonitor data source using the agent method,
apply the following configuration using the sloctl apply -f
command:
apiVersion: n9/v1alpha
kind: Agent
metadata:
# String, mandatory a-z, 0-9, and "-" only. The data source name identifier
name: my-logic-monitor-data-source
# String, optional. The data source user-friendly name
displayName: My LogicMonitor data source
# String, mandatory. The name identifier of the project to locate your data source in
project: my-project
spec:
# String, optional
description: Sample LogicMonitor data source (agent connection)
# String, mandatory. Currently, beta for LogicMonitor
releaseChannel: beta
# Source-specific fields
logicMonitor:
# String, mandatory. Replace with your LogicMonitor account
account: my-account-name
# Mandatory. The query delay settings
queryDelay:
value: 3
historicalDataRetrieval:
maxDuration:
value: 30
unit: Day
defaultDuration:
value: 15
unit: Day
Field | Type | Description |
---|---|---|
queryDelay.unit mandatory | enum | Specifies the unit for the query delay. Possible values: Second | Minute . β’ Check query delay documentation for default unit of query delay for each source. |
queryDelay.value mandatory | numeric | Specifies the value for the query delay. β’ Must be a number less than 1440 minutes (24 hours). β’ Check query delay documentation for default unit of query delay for each source. |
releaseChannel mandatory | enum | Specifies the release channel. Accepted values: beta | stable . |
Source-specific fields | ||
logicMonitor.account mandatory | string | Your LogicMonitor account. |
You can directly apply the YAML or save the configuration as a YAML file
and pass it with the sloctl apply -f %path-to-your-file.yaml%
command.
Agent deploymentβ
When you add a data source, Nobl9 automatically generates a Kubernetes configuration and a Docker command line for you to deploy the agent. Both configurations are available on the Nobl9 Web under the data source details > Agent configuration tab.
Agent deployment requires client_id
and client_secret
. To retrieve their values, run sloctl get agents -p <YOUR_PROJECT_NAME> -k
.
- Kubernetes
- Docker
If you use Kubernetes, you can apply the supplied YAML config file to a Kubernetes cluster to deploy the agent. The agent facilitates Nobl9 to import your service metrics.
DISCLAIMER: This deployment description contains only the fields necessary for the purpose of this demo.
It is not a ready-to-apply k8s deployment description. Replace LOGIC_MONITOR_ACCESS_ID
and LOGIC_MONITOR_ACCESS_KEY
with your organization keys.
apiVersion: v1
kind: Secret
metadata:
# String, mandatory. The deployment name identifier
name: nobl9-agent-my-organization-my-project-logic-monitor
namespace: my-namespace
type: Opaque
stringData:
# Replace with your LogicMonitor access ID
n9_logic_monitor_access_id: "<LOGIC_MONITOR_ACCESS_ID>"
# Replace with your LogicMonitor access key
n9_logic_monitor_access_key: "<LOGIC_MONITOR_ACCESS_KEY>"
# Replace with your Nobl9 client ID
client_id: "<YOUR_NOBL9_CLIENT_ID>"
# Replace with your Nobl9 client secret
client_secret: "<YOUR_NOBL9_CLIENT_SECRET>"
---
apiVersion: apps/v1
kind: Deployment
metadata:
name: nobl9-agent-my-organization-my-project-logic-monitor
namespace: my-namespace
spec:
replicas: 1
selector:
matchLabels:
nobl9-agent-name: "logic-monitor"
nobl9-agent-project: "my-project"
nobl9-agent-organization: "my-organization"
template:
metadata:
labels:
nobl9-agent-name: "logic-monitor"
nobl9-agent-project: "my-project"
nobl9-agent-organization: "my-organization"
spec:
containers:
- name: agent-container
image: nobl9/agent:0.88.0-beta
resources:
requests:
memory: "700Mi"
cpu: "0.2"
env:
- name: N9_CLIENT_ID
valueFrom:
secretKeyRef:
key: client_id
name: nobl9-agent-my-organization-my-project-logic-monitor
- name: N9_LOGIC_MONITOR_ACCESS_ID
valueFrom:
secretKeyRef:
key: n9_logic_monitor_access_id
name: nobl9-agent-my-organization-my-project-logic-monitor
- name: N9_LOGIC_MONITOR_ACCESS_KEY
valueFrom:
secretKeyRef:
key: n9_logic_monitor_access_key
name: nobl9-agent-my-organization-my-project-logic-monitor
- name: N9_INTAKE_URL
value: "https://{your-instance}.nobl9.com/api/input"
- name: N9_QUERYENGINE_URL
value: "https://{your-instance}.nobl9.com/api/queryengine"
- name: N9_CLIENT_SECRET
valueFrom:
secretKeyRef:
key: client_secret
name: nobl9-agent-my-organization-my-project-logic-monitor
- name: N9_AUTH_SERVER
value: "<YOUR_N9_AUTH_SERVER_ID>"
- name: N9_OKTA_ORG_URL
value: "https://accounts.nobl9.com"
- name: N9_METRICS_PORT
value: "9090"
- name: N9_NATS_URL
# A wss:// URL
value: "<YOUR_NOBL9_NATS_URL>"
Important notes:
- The
N9_METRICS_PORT
is a variable specifying the port to which the/metrics
and/health
endpoints are exposed. 9090
is the default value and can be changed.- If you donβt want the metrics to be exposed, comment out or delete the
N9_METRICS_PORT
variable.
If you use Docker, you can run the provided Docker command to deploy the agent. The agent facilitates Nobl9 to import your service metrics.
Replace LOGIC_MONITOR_ACCESS_ID
and LOGIC_MONITOR_ACCESS_KEY
with your organization keys.
docker run -d --restart on-failure \
--name nobl9-agent-my-organization-my-project-logic-monitor \
-e N9_INTAKE_URL="https://{your-instance}.nobl9.com/api/input" \
-e N9_QUERYENGINE_URL="https://{your-instance}.nobl9.com/api/queryengine" \
-e N9_OKTA_ORG_URL="https://accounts.nobl9.com" \
-e N9_AUTH_SERVER="<YOUR_NOBL9_AUTH_SERVER_ID>" \
-e N9_CLIENT_SECRET="<YOUR_NOBL9_CLIENT_SECRET>" \
-e N9_METRICS_PORT=9090 \
#A wss:// URL
-e N9_NATS_URL="<YOUR_NOBL9_NATS_URL>" \
-e N9_CLIENT_ID="<YOUR_NOBL9_CLIENT_ID>" \
-e N9_LOGIC_MONITOR_ACCESS_ID="<LOGIC_MONITOR_ACCESS_ID>" \
-e N9_LOGIC_MONITOR_ACCESS_KEY="<LOGIC_MONITOR_ACCESS_KEY>" \
nobl9/agent:0.88.0-beta
Important notes:
- The
N9_METRICS_PORT
is a variable specifying the port to which the/metrics
and/health
endpoints are exposed. 9090
is the default value and can be changed.- If you donβt want the metrics to be exposed, comment out or delete the
N9_METRICS_PORT
variable.
Creating SLOs with LogicMonitorβ
Currently, you can create SLOs based on LogicMonitor and edit them using sloctl
or Terraform.
Once created, your LogicMonitor SLO is available in the SLO grid. You can check its charts and other data on your SLO details page.
Tips on retrieving SLI data in LogicMonitorβ
To run an SLI with Nobl9, the following values are required:
deviceDataSourceInstanceID
The identifier of a monitoring rule configuration or occurrence applied to a LogicMonitor device you need to monitor.graphID
Refers to the graph configuration associated with your required device and defines how monitoring data collected by this device is visualized and presented in LogicMonitor.line
Refers to theline.label
field.
- Log in to your LogicMonitor dashboard.
- In the navigation sidebar, go to Resources.
- Select the required instance under the data source that holds it.
- Under the Info tab, copy the
system.instanceId
value in the list of properties. Use it as the value fordeviceDataSourceInstanceID
. - Open the Graphs tab.
- Unfold the graph options menu.
Select Graph Definitions (opened in the new page):
- Find the
graphID
value at the end of the URL:...exchangeDataSourceGraphs-XXXXX
, where theXXXXX
part is thegraphID
value. - Go to the Lines table at the bottom of the page.
The value under the Datapoint column is yourline
.
Provide theline
value in your Nobl9 SLO in upper case.
You can also retrieve these values calling the following LogicMonitor API:
deviceDataSourceInstanceID
:GET /device/devices/{deviceId}/devicedatasources/{hdsId}/instances
graphID
:GET /device/devices/{deviceId}/devicedatasources/{id}
line
:GET /device/devicedatasourceinstances/{instanceId}/graphs/{graphId}/data
Pass the obtained values in the YAML file with your LogicMonitor SLO.
countMetrics
), keep in mind that the values ββresulting from that query for both good and total:- Must be positive.
- While we recommend using integers, fractions are also acceptable.
- If using fractions, we recommend them to be larger than
1e-4
=0.0001
. - Shouldn't be larger than
1e+20
.
Nobl9 Webβ
- Navigate to Service Level Objectives.
- Click .
- Select a Service.
It will be the location for your SLO in Nobl9. - Select your LogicMonitor data source.
- Modify Period for Historical Data Retrieval, when necessary.
- This value defines how far back in the past your data will be retrieved when replaying your SLO based on LogicMonitor.
- A longer period can extend the data loading time for your SLO.
- Must be a positive whole number up to the maximum period value you've set when adding the LogicMonitor data source.
- Select the Metric type:
- Threshold metric: a single time series is evaluated against a threshold.
- A Ratio metric: two-time series for comparison. For a ratio metric:
- Select the Data count method: incremental or non-incremental.
- Specify a time series for comparison against total: a good metric means a ratio of good events or bad metric, a ratio of bad events.
-
A LogicMonitor query must follow the below patters:
- Query Type: currently, only the
device_metrics
type is available - Device Data Source Instance ID: the identifier of a monitoring rule configuration or occurrence applied to your LogicMonitor device.
- Graph ID: a 5-symbol graph configuration.
- Line: the Datapoint value.
Uppercase only.
infoTips on retrieving SLI data in LogicMonitor provide instructions on retrieving the required values.
- Query Type: currently, only the
- Define the Time Window for your SLO:
- Rolling time windows constantly move forward as time passes. This type can help track the most recent events.
- Calendar-aligned time windows are usable for SLOs intended to map to business metrics measured on a calendar-aligned basis.
- Configure the Error budget calculation method and Objectives:
- Occurrences method counts good attempts against the count of total attempts.
- Time Slices method measures how many good minutes were achieved (when a system operates within defined boundaries) during a time window.
- You can define up to 12 objectives for an SLO.
Similar threshold values for objectivesTo use similar threshold values for different objectives in your SLO, we recommend differentiating them by setting varying decimal points for each objective.
For example, if you want to use threshold value1
for two objectives, set it to1.0000001
for the first objective and to1.0000002
for the second one.
Learn more about threshold value uniqueness. - Add the Display name, Name, and other settings for your SLO:
- Name identifies your SLO in Nobl9. After you save the SLO, its name becomes read-only.
Use only lowercase letters, numbers, and dashes. - Create Composite SLO: with this option selected, you create a composite SLO 1.0. Composite SLOs 1.0 are deprecated. They're fully operable; however, we encourage you to create new composite SLOs 2.0.
You can create composite SLOs 2.0 withsloctl
using the provided template. Alternatively, you can create a composite SLO 2.0 with Nobl9 Terraform provider. - Set Notifications on data. With it, Nobl9 will notify you in the cases when SLO won't be reporting data or report incomplete data for more than 15 minutes.
- Add alert policies, labels, and links, if required.
Up to 20 items of each type per SLO is allowed.
- Name identifies your SLO in Nobl9. After you save the SLO, its name becomes read-only.
- Click CREATE SLO
sloctlβ
To create an SLO based on LogicMonitor, pass the required configuration with the sloctl apply -f
command.
Your configuration must follow the pattern either for the threshold (raw) or ratio (count) metrics.
Refer to the YAML guide > SLO for more information about the fields.
- Threshold metric
- Ratio metric
- apiVersion: n9/v1alpha
kind: SLO
metadata:
name: my-raw-slo
displayName: My LogicMonitor threshold SLO
project: my-project
# Optional
labels:
key-1:
- value-1
- value-2
key-2:
- value-1
- value-2
# Optional
annotations:
key-1: value-1
key-2: value-2
spec:
description: Sample LogicMonitor threshold SLO
indicator:
metricSource:
name: my-logic-monitor-data-source
project: my-project
kind: Direct
budgetingMethod: Occurrences
objectives:
- displayName: Good response (200)
value: 200.0
name: good-response
target: 0.95
rawMetric:
query:
logicMonitor:
queryType: device_metrics
# Numeric, mandatory.
# The identifier of a monitoring rule configuration or occurrence applied to a LogicMonitor device you need to monitor
deviceDataSourceInstanceId: <YOUR_SYSTEM_INSTANCE_ID>
# Numeric, mandatory.
# A 5-digit identifier of the configuration of the graph associated with the device you need to monitor
graphId: <YOUR_GRAPH_ID>
# String, mandatory. Uppercase only. The Lines > Datapoint value
line: <YOUR_LINE_VALUE>
op: lte
primary: true
service: my-service
timeWindows:
- unit: Month
count: 1
isRolling: false
calendar:
startTime: 2022-12-01 00:00:00
timeZone: UTC
# Optional
alertPolicies:
- my-alert-policy-1
- my-alert-policy-2
# Optional
attachments:
- url: https://{my-website}.com
displayName: My website attached to this SLO
# Optional. The No-data anomaly notifications (beta)
anomalyConfig:
noData:
alertMethods:
- name: my-alert-method
project: my-project
- apiVersion: n9/v1alpha
kind: SLO
metadata:
name: my-count-slo
displayName: My LogicMonitor ratio SLO good over total
project: my-project
# Optional
labels:
key-1:
- value-1
- value-2
key-2:
- value-1
- value-2
# Optional
annotations:
key-1: value-1
key-2: value-2
spec:
description: Sample LogicMonitor ratio SLO
indicator:
metricSource:
name: my-logic-monitor-data-source
project: my-project
kind: Direct
budgetingMethod: Occurrences
objectives:
- displayName: Good response (200)
value: 1.0
name: good-response
target: 0.95
countMetrics:
incremental: true
good:
logicMonitor:
# Numeric, mandatory.
# The identifier of a monitoring rule configuration or occurrence applied to a LogicMonitor device you need to monitor
deviceDataSourceInstanceId: <YOUR_SYSTEM_INSTANCE_ID>
# Numeric, mandatory.
# A 5-digit identifier of the configuration of the graph associated with the device you need to monitor
graphId: <YOUR_GRAPH_ID_1>
# String, mandatory. Uppercase only. The Lines > Datapoint value
line: <YOUR_LINE_VALUE>
total:
logicMonitor:
# Numeric, mandatory.
# The identifier of a monitoring rule configuration or occurrence applied to a LogicMonitor device you need to monitor
deviceDataSourceInstanceId: <YOUR_SYSTEM_INSTANCE_ID>
# Numeric, mandatory.
# A 5-digit identifier of the configuration of the graph associated with the device you need to monitor
graphId: <YOUR_GRAPH_ID_2>
# String, mandatory. Uppercase only. The Lines > Datapoint value
line: <YOUR_LINE_VALUE>
primary: true
service: my-service
timeWindows:
- unit: Month
count: 1
isRolling: false
calendar:
startTime: 2022-12-01 00:00:00
timeZone: UTC
# Optional
alertPolicies:
- my-alert-policy-1
- my-alert-policy-2
# Optional
attachments:
- url: https://{my-website}.com
displayName: My website attached to this SLO
# Optional. The No-data anomaly notifications (beta)
anomalyConfig:
noData:
alertMethods:
- name: my-alert-method
project: my-project
Find more SLO samples in the Nobl9 SDK.
To check your created SLO with sloctl
, run sloctl get slos
.
Also, you can check it on the Nobl9 Web in the SLO grid page.
You can replay your LogicMonitor SLOs in the following ways:
- Go to the required SLO details. Click More Actions > Run Replay.
- Run
sloctl replay
.
LogicMonitor API rate limitsβ
LogicMonitor limits GET requests to 500 per minute.
Read more about rate limiting in LogicMonitor.
You can optimize the rate limit usage, which is particularly beneficial when you have hundreds of SLIs. For this, keep an individual data source in Nobl9 per LogicMonitor instance, ensuring a single rate limit.
It makes possible batching queries by graphId
and instanceId
and
reading time series from responses per graphId
, instanceId
, and line
(an SLI identifier).
As a result, Nobl9 can query for unique lines only once, even if graphId
and instanceId
include multiple lines.
The maximum number of lines graphId
and instanceId
can return varies by case and depends on how metrics are organized.