Skip to main content

LogicMonitor

Reading time: 0 minute(s) (0 words)

LogicMonitor is a SaaS-based monitoring platform that automates IT system monitoring. It provides a centralized view of various IT components, including networks, cloud environments, servers, and applications. LogicMonitor offers automated monitoring and data insights.

Nobl9 integrates with LogicMonitor, enabling you to create threshold and ratio SLOs for tracking the reliability of your LogicMonitor devices and websites. To do this, select the required query type—device_metrics or website_metrics—in Nobl9 and provide the necessary parameters for your LogicMonitor device or website.

LogicMonitor parameters and supported features in Nobl9
General support:
Release channel: Beta
Connection method: Agent, Direct
Replay and SLI Analyzer: Historical data limit 30 days
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:
Plugin name: n9logic_monitor
Query delay environment variable: LOGIC_MONITOR_QUERY_DELAY
Replay and SLI Analyzer: 0.81.0-beta
Query parameters retrieval: 0.76.0-beta
Timestamp cache persistence: 0.76.0-beta
Additional notes:
Create SLOs to track your LogicMonitor devices and websites
Bad over total ratio metrics

Creating SLOs with LogicMonitor​

You can create SLOs using the device or website LogicMonitor metrics.

Nobl9 Web​

  1. Navigate to Service Level Objectives.
  2. Click .
  3. Select a Service.
    It will be the location for your SLO in Nobl9.
  4. Select your LogicMonitor data source.
  5. Modify Period for Historical Data Retrieval, if 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.

    Non-editable Replay period
    Non-editable Replay period indicates that the maximum period for historical data retrieval set for your LogicMonitor data source is set to zero.
    Adjust the data source settings to create the SLO with Replay.
  6. Metric refers to the way of calculating and interpreting calculate and interpret data from your data source.
    • Threshold metric is defined by a single numerical value (the threshold) that separates satisfactory performance from unsatisfactory performance. It's represented by a single time series evaluated against the threshold.
    • Ratio metric expresses the performance as a fraction or proportion, typically by dividing the number of successful or unsuccessful events by the total number of potential events (successes + failures). It's represented by two-time series for comparison for good or bad events and total events.
      For ratio metrics, select the Data count method.

      SLI values for good and total
      When choosing the query for the ratio SLI (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.
  1. A LogicMonitor query must follow the below patters:
  • Query Type: device_metrics
  • 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.
    Enter the Line value in uppercase.

Find out how to retrieve these values in LogicMonitor.

SLI data retrieval

Tips on retrieving SLI data in LogicMonitor provide instructions on retrieving the required values.

  1. Define the Time window for your SLO:
  2. 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 objectives
      To 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 value 1 for two objectives, set it to 1.0000001 for the first objective and to 1.0000002 for the second one.
  3. 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.
    • Select No data anomaly alert to receive notifications when your SLO stops reporting data for a specified period:
      • Choose up to five supported Alert methods.
      • Specify the delay period before Nobl9 sends an alert about the missing data.
        From 5 minutes to 31 days. Default: 15 minutes
    • Add alert policies, labels, and links, if required.
      Limits per SLO: 20 alert policies or links, 30 labels.
  4. Click CREATE SLO.

    5. SLO configuration use case
    Check the SLO configuration use case for a real-life SLO example.

YAML​

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.

Breaking changes in Nobl9 agent 0.87.0-beta

Nobl9 agent 0.87.0-beta and later require quotation marks around these fields:

  • LogicMonitor device SLOs:

    • deviceDataSourceInstanceId
    • graphId

  • LogicMonitor website SLOs:

    • websiteId
    • checkpointId
    • graphName

Omitting quotation marks in these fields with Nobl9 agent 0.87.0-beta or later results in an error. Earlier agent versions do not require quotation marks.

Review and correct your LogicMonitor device and website SLOs as needed.

Device metrics​

Sample LogicMonitor threshold SLO
apiVersion: n9/v1alpha
kind: SLO
metadata:
  name: api-server-slo
  displayName: API Server SLO
  project: default
  labels:
    area:
      - latency
      - slow-check
    env:
      - prod
      - dev
    region:
      - us
      - eu
    team:
      - green
      - sales
  annotations:
    area: latency
    env: prod
    region: us
    team: sales
spec:
  description: Example LogicMonitor SLO
  indicator:
    metricSource:
      name: logic-monitor
      project: default
      kind: Agent
  budgetingMethod: Occurrences
  objectives:
    - displayName: Good response (200)
      value: 200
      name: ok
      target: 0.95
      rawMetric:
        query:
          logicMonitor:
            queryType: device_metrics
            line: CONNECTIONSESTABLISHED
            deviceDataSourceInstanceId: 933147615
            graphId: 11436
      op: lte
      primary: true
  service: api-server
  timeWindows:
    - unit: Month
      count: 1
      isRolling: false
      calendar:
        startTime: '2022-12-01 00:00:00'
        timeZone: UTC
  alertPolicies:
    - fast-burn-5x-for-last-10m
  attachments:
    - url: https://docs.nobl9.com
      displayName: Nobl9 Documentation
  anomalyConfig:
    noData:
      alertMethods:
        - name: slack-notification
          project: default
      alertAfter: 1h
Click to open field reference
FieldTypeDescription
apiVersion
mandatory
stringAPI version. Use n9/v1alpha
kind
mandatory
stringThe resource type. Use SLO
Metadata
metadata.name
mandatory
stringName identifier for the SLO. Use only lowercase alphanumeric characters
metadata.displayNamestringUser-friendly SLO name
metadata.project
mandatory
stringThe name identifier of the project where you need to host your SLO
metadata.labelsobject (map: string[])Grouping labels for filtering or viewing
metadata.annotationsobject (map: string)Flat string annotations
Spec
spec.descriptionstringSLO description
spec.indicator.metricSource.name
mandatory
stringData source name
spec.indicator.metricSource.project
mandatory
stringProject containing the data source
spec.indicator.metricSource.kind
mandatory
stringData source connection method. Can be Agent or Direct
spec.budgetingMethod
mandatory
enumError budget calculation method. Can be Occurrences or Time slices
spec.objectives
mandatory
arrayYour SLO objective definition, up to 12 objectives per SLO.
spec.objectives[].displayNamestringUser-friendly objective name
spec.objectives[].value
mandatory
numberData point values that is considered "good" (e.g., 200.0).
In SLOs with two or more objectives, keep each objective's value unique.
In ratio (count) metrics, value is retained for legacy purposes.
spec.objectives[].name
mandatory
stringName identifier for this objective
spec.objectives[].op
mandatory
string (enum)Operator for objective. One of:
lte (less than or equal to)
lt (less than)
gte (greater than or equal to)
gt (greater than)
spec.objectives[].target
mandatory
floatThe percentage of the good minutes or occurrences that must meet the desired performance (e.g., is the target is 0.95, the good performance is expected to be observed in at least 95% of the time window)
spec.objectives[].rawMetric/.countMetric
mandatory
objectThe metric type indicator. Set:
rawMetric for a threshold metric
countMetric for a ratio metric.
A ratio metric requires the additional fields:
countMetric.incremental (boolean) the data count method
countMetric.good/.bad and countMetric.total a numerator and denominator queries
spec.objectives[].countMetric.incremental
mandatory
booleanThe data count method for a ratio (countMetric) metric type
spec.objectives[].primarybooleanThe indicator of a primary SLO objective
spec.service
mandatory
stringThe name identifier of a service to host this SLO. The service must exist in the project specified in metadata.project
spec.timeWindows
mandatory
arrayDefines SLO time window for error budget calculation. Set:
isRolling: true for the rolling time window type
isRolling: false for the calendar-aligned type
spec.timeWindows.unit
mandatory
integerThe time window units. One of:
Day | Hour | Minute for the rolling time window
Year | Quarter | Month | Week | Day for the calendar-aligned time window
spec.timeWindows.count
mandatory
integerThe number of units in a time window
spec.timeWindows.startTimestringMandatory for calendar-aligned time windows. Date and time in the format YYYY-MM-DDTHH:mm:ss
spec.timeWindows.timeZonestringMandatory for calendar-aligned time-windows. A valid IANA Time Zone Database name
spec.timeWindows.isRolling
mandatory
boolean
true for the rolling time window type
false for the calendar-aligned type
spec.alertPoliciesarrayThe name identifiers of alert policies to be linked to this SLO (must be from the same project as the SLO). Up to 20 alert policies per SLO.
spec.attachmentsarrayLinks to any additional attributes of this SLO
spec.anomalyConfigobjectSettings for a manual no data anomaly detection rule
spec.noData.alertMethodsarrayList of alert methods for no-data anomaly. Up to five alert methods per SLO. Every alert method must have the name and project fields
spec.noData.alertAfterstringWaiting time before sending a no-data notification. Must be 5m to 31d.
Default: 15m
Source-specific fields
logicmonitor.queryType
mandatory
stringThe type of the query. One of: device_metrics | website_metrics
logicmonitor.line
mandatory
stringThe datapoint of your required graph. The value must be uppercase
logicmonitor.deviceDataSourceInstanceId
mandatory
stringThe identifier of a monitoring rule configuration or occurrence applied to a LogicMonitor device to be monitored
logicmonitor.graphId
mandatory
stringThe graph configuration associated with your required device and defines how monitoring data collected by this device is visualized and presented in LogicMonitor

Website metrics​

Sample LogicMonitor threshold SLO
apiVersion: n9/v1alpha
kind: SLO
metadata:
  name: api-server-slo
  displayName: API Server SLO
  project: default
  labels:
    area:
      - latency
      - slow-check
    env:
      - prod
      - dev
    region:
      - us
      - eu
    team:
      - green
      - sales
  annotations:
    area: latency
    env: prod
    region: us
    team: sales
spec:
  description: Example LogicMonitor SLO
  indicator:
    metricSource:
      name: logic-monitor
      project: default
      kind: Agent
  budgetingMethod: Occurrences
  objectives:
    - displayName: Good response (200)
      value: 200.0
      name: ok
      target: 0.95
      rawMetric:
        query:
          logicMonitor:
            queryType: website_metrics
            line: MIN RTT
            websiteId: "1"
            checkpointId: "1044712023"
            graphName: responseTime
      op: lte
      primary: true
  service: api-server
  timeWindows:
    - unit: Month
      count: 1
      isRolling: false
      calendar:
        startTime: "2022-12-01 00:00:00"
        timeZone: UTC
  alertPolicies:
    - fast-burn-5x-for-last-10m
  attachments:
    - url: https://docs.nobl9.com
      displayName: Nobl9 Documentation
  anomalyConfig:
    noData:
      alertMethods:
        - name: slack-notification
          project: default
      alertAfter: 1h
Click to open field reference
FieldTypeDescription
apiVersion
mandatory
stringAPI version. Use n9/v1alpha
kind
mandatory
stringThe resource type. Use SLO
Metadata
metadata.name
mandatory
stringName identifier for the SLO. Use only lowercase alphanumeric characters
metadata.displayNamestringUser-friendly SLO name
metadata.project
mandatory
stringThe name identifier of the project where you need to host your SLO
metadata.labelsobject (map: string[])Grouping labels for filtering or viewing
metadata.annotationsobject (map: string)Flat string annotations
Spec
spec.descriptionstringSLO description
spec.indicator.metricSource.name
mandatory
stringData source name
spec.indicator.metricSource.project
mandatory
stringProject containing the data source
spec.indicator.metricSource.kind
mandatory
stringData source connection method. Can be Agent or Direct
spec.budgetingMethod
mandatory
enumError budget calculation method. Can be Occurrences or Time slices
spec.objectives
mandatory
arrayYour SLO objective definition, up to 12 objectives per SLO.
spec.objectives[].displayNamestringUser-friendly objective name
spec.objectives[].value
mandatory
numberData point values that is considered "good" (e.g., 200.0).
In SLOs with two or more objectives, keep each objective's value unique.
In ratio (count) metrics, value is retained for legacy purposes.
spec.objectives[].name
mandatory
stringName identifier for this objective
spec.objectives[].op
mandatory
string (enum)Operator for objective. One of:
lte (less than or equal to)
lt (less than)
gte (greater than or equal to)
gt (greater than)
spec.objectives[].target
mandatory
floatThe percentage of the good minutes or occurrences that must meet the desired performance (e.g., is the target is 0.95, the good performance is expected to be observed in at least 95% of the time window)
spec.objectives[].rawMetric/.countMetric
mandatory
objectThe metric type indicator. Set:
rawMetric for a threshold metric
countMetric for a ratio metric.
A ratio metric requires the additional fields:
countMetric.incremental (boolean) the data count method
countMetric.good/.bad and countMetric.total a numerator and denominator queries
spec.objectives[].countMetric.incremental
mandatory
booleanThe data count method for a ratio (countMetric) metric type
spec.objectives[].primarybooleanThe indicator of a primary SLO objective
spec.service
mandatory
stringThe name identifier of a service to host this SLO. The service must exist in the project specified in metadata.project
spec.timeWindows
mandatory
arrayDefines SLO time window for error budget calculation. Set:
isRolling: true for the rolling time window type
isRolling: false for the calendar-aligned type
spec.timeWindows.unit
mandatory
integerThe time window units. One of:
Day | Hour | Minute for the rolling time window
Year | Quarter | Month | Week | Day for the calendar-aligned time window
spec.timeWindows.count
mandatory
integerThe number of units in a time window
spec.timeWindows.startTimestringMandatory for calendar-aligned time windows. Date and time in the format YYYY-MM-DDTHH:mm:ss
spec.timeWindows.timeZonestringMandatory for calendar-aligned time-windows. A valid IANA Time Zone Database name
spec.timeWindows.isRolling
mandatory
boolean
true for the rolling time window type
false for the calendar-aligned type
spec.alertPoliciesarrayThe name identifiers of alert policies to be linked to this SLO (must be from the same project as the SLO). Up to 20 alert policies per SLO.
spec.attachmentsarrayLinks to any additional attributes of this SLO
spec.anomalyConfigobjectSettings for a manual no data anomaly detection rule
spec.noData.alertMethodsarrayList of alert methods for no-data anomaly. Up to five alert methods per SLO. Every alert method must have the name and project fields
spec.noData.alertAfterstringWaiting time before sending a no-data notification. Must be 5m to 31d.
Default: 15m
Source-specific fields
logicmonitor.queryType
mandatory
stringThe type of the query. One of: website_metrics | device_metrics
logicmonitor.line
mandatory
stringThe label of your required graph line. The value must be uppercase
logicmonitor.websiteId
mandatory
stringThe identifier of the monitored website. This value uniquely identifies the website you track within LogicMonitor. Put the value in quotation marks
logicmonitor.checkpointId
mandatory
stringThe identifier of a checkpoint associated with a website. A checkpoint is a specific monitoring location or probe used by LogicMonitor to test website availability and performance. Put the value in quotation marks
logicmonitor.graphName
mandatory
stringThe identifier of the specific graph to be monitored

Find more SLO samples in the Nobl9 SDK.

Tips on retrieving SLI data in LogicMonitor​

For correct monitoring, Nobl9 SLOs based on LogicMonitor require specific data, depending on a resource you need to monitor—a device or website. To retrieve the required values, do the following:

  1. Log in to your LogicMonitor dashboard.
  2. In the navigation sidebar, click Resource Tree.
    All your monitored devices are listed here.
  3. Select the required Resource > DataSource > instance.
Device Data Source Instance ID

The identifier of a monitoring rule configuration or occurrence applied to a LogicMonitor device you need to monitor.

LogicMonitor UI location:
Go to the Info tab
Copy the system.instanceID property value
API endpoint for retrieval:
GET /device/devices/{deviceId}/devicedatasources/{hdsId}/instances
Nobl9 YAML definition:
deviceDataSourceInstanceId
Type: string

Graph ID

Graph configuration associated with your required device and defines how monitoring data collected by this device is visualized and presented in LogicMonitor

LogicMonitor UI location:
The Graphs tab > click ellipses > Graph Definition (opens in the new tab)
The required device's URL ending
For example, XXXXX in ...exchangeDataSourceGraphs-XXXXX
API endpoint for retrieval:
GET /device/devices/{deviceId}/devicedatasources/{id}
Nobl9 YAML definition
graphId
Type: string

Line

A datapoint of your required graph

LogicMonitor UI location:
The Graphs tab > click ellipses > Graph Definition (opens in the new tab)
The Datapoint value of your required graph found in the Lines table or the line.label value
API endpoint for retrieval:
GET /device/devicedatasourceinstances/{instanceId}/graphs/{graphId}/data
Nobl9 YAML definition:
line
Pass its value in uppercase

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 depends on the way of metric organization.

Check out these related guides and references:
Add LogicMonitor as a data sourceAdding data sourcesRate limiting in LogicMonitorLogicMonitor documentationsloctl user guidesloctlsloctl common objectssloctlsloctl applysloctlCreating SLOs via TerraformTerraform
On this page