Welcome to InsightFinder Docs!
Categories
InsightFinder Terraform Provider Configurations
This document provides a comprehensive reference for all configurable items in the InsightFinder Terraform Provider.
Provider Configuration
The provider requires authentication with the InsightFinder API.
| Argument | Description | Environment Variable | Required |
| base_url | The base URL for the InsightFinder API. Default: https://app.insightfinder.com | IF_BASE_URL | Yes |
| username | The username for InsightFinder authentication. | IF_USERNAME | No (if Env var set) |
| license_key | The license key (API key) for InsightFinder authentication. | IF_LICENSE_KEY | No (if Env var set) |
Resources
insightfinder_project
Manages an InsightFinder project. This resource has extensive configuration options for fine-tuning project behavior.
Required Arguments
| Argument | Description |
| project_name | The unique name of the project. |
| system_name | The system name this project belongs to. |
| project_creation_config | A block defining project creation parameters (see below). |
Project Creation Config Block
| Argument | Description |
| data_type | The type of data (e.g., Log, Metric, Trace). |
| instance_type | The instance type (e.g., PrivateCloud, AWS, Azure).
Default: PrivateCloud |
| project_cloud_type | The cloud type for the project. (e.g. PrivateCloud) |
| insight_agent_type | The InsightFinder agent type. (e.g. Custom) |
Optional Arguments
General Settings
| Argument | Description |
| project_display_name | The display name for the project. |
| project_time_zone | The timezone for the project (default: UTC).
Default Value: UTC |
| sampling_interval | The sampling interval in seconds.
Default Value: 600 |
| c_value | The C value for anomaly detection sensitivity (typically 2-5). |
| p_value | The P value for anomaly detection probability (0.0-1.0). |
| retention_time | Data retention time in days.
Default Value: 90 |
| ubl_retention_time | Retention time for UBL data in days
Default Value: 90 |
Anomaly Detection & Alerts
| Argument | Description |
| anomaly_detection_mode | Enable/Disable anomaly detection for log data.
Options:
|
| anomaly_sampling_interval | The time window (in seconds) used for log anomaly detection.
Default value: 60 |
| enable_anomaly_score_escalation | (For Metric Project only)
Enable/Disable the system to automatically “escalate” incidents based on escalation_anomaly_score_threshold. Options:
|
| escalation_anomaly_score_threshold | (For Metric Project only)
If the calculated anomaly score is greater than or equal to this threshold, the system flags it for escalation. Range: Typically between 0.0 and 1.0 (representing a percentage-based score).
|
| ignore_anomaly_score_threshold | (For Metric Project only)
Let the system ignore anomalies that have a score below this specific value.
|
| enable_hot_event | (For Log Project only)
Enable/Disable hot/rare event detection.
|
| hot_event_threshold | (For Log Project only)
Sets the limit for the maximum allowable count of a specific log pattern within a sampling interval before it is classified as an anomaly.
|
| hot_event_calm_down_period | (For Log Project only)
Once a specific log pattern triggers a “Hot Event” anomaly, the system starts a “calm down” timer. Any subsequent spikes of that same pattern within this period will be recorded but will not generate new alerts or incidents.
|
| hot_event_detection_mode | (For Log Project only)
This option tells the system how to decide if a volume of logs is high enough to be considered “Hot.” Default value: 0 Options:
|
| hot_number_limit | (For Log Project only)
It limits the total number of unique log patterns that can be classified as “Hot” within a single processing cycle or stored in the project’s state.
|
| cold_event_threshold | (For Log Project only)
Defines the sensitivity for triggering “Cold Event” alerts.
|
| cold_number_limit | (For Log Project only)
The maximum number of cold events detected per day Default value: 0 |
| rare_anomaly_type | (For Log Project only)
Defines how the system categorizes and handles “rare” (infrequent or new) log patterns during anomaly detection. Default Value: 0 Options:
|
| rare_event_alert_thresholds | (For Log Project only)
It sets a limit on the cluster size or frequency of a rare event before it triggers an alert.
|
| rare_number_limit | (For Log Project only)
It limits the total number of unique log patterns that can be classified as “Rare” at once.
|
| collect_all_rare_events_flag | (For Log Project only)
It determines whether the system should capture and store every single rare event it encounters or only a representative subset.
|
| enable_new_alert_email | A notification configuration that controls whether the system sends email alerts specifically for newly detected anomalies and incidents.
|
| new_alert_flag | (For Log Project only)
A configuration for Log projects that manages how the system identifies and presents “new” vs. “recurring” anomalies in the UI and notification pipeline.
|
| alert_average_time | (For Metric Project only)
Determine the duration over which the system calculates average metric values when evaluating alert conditions.
|
| alert_hourly_cost | A monetary value to the downtime or degraded performance of a specific system.
|
| enable_stream_detection | (For Metric Project only)
It switches the metric detection engine from a traditional batch-processing mode (which might run every few minutes) to a Streaming Detection mode.
|
Log Settings
| Argument | Description |
| log_detection_min_count | Minimum count for triggering log detection in a batch.
Default value: 10000 Example: Set this value to 10000 The log detection will be triggered immediately if at least 10000 log entries are available in a batch. Otherwise the log detection will wait until 3 minutes later. |
| log_detection_size | Maximum count for triggering log detection in a batch.
Default value: 30000 Example: Set this value to 30000 The log detection will be triggered immediately if at most 30000 log entries are available in a batch. Otherwise the log detection will wait until 3 minutes later. |
| log_pattern_limit_level | Limit level for log patterns.
Default value:1024 The limit of different patterns. If the pattern generate more than the number, then the new pattern will be all assigned as MISC(-2) miscellaneous pattern |
| max_log_model_size | Maximum training data sample value per model
Default value: 10000 The number of the logs to train the model |
| keyword_feature_number | Number of keyword features (Feature vector length)
Default value:200 The number of the feature vectors generated for training the model |
| keyword_setting | Keyword setting configuration.
Default value: -1 The keyword setting when collecting and using during the keyword query. -1 is disabled as default. 0 is letter only, 1 is letter and number |
| model_keyword_setting | Model keyword setting.
Default value: 0 The keyword selection during the model training. Default 0 is letter only, which only collects the keywords are pure alphabet. 1 is lettern and number |
| disable_model_keyword_stats_collection | Disable model keyword stats collection.
Default value: false Collect the frequency of keywords for the model training |
| disable_log_compress_event | Disable log compress event.
Default value: false Setting to disable saving the log data |
| log_anomaly_event_base_score | Base score for log anomaly events.
Default value: “[5,0.01,0.0075,0.01,1,100]” Setting to adjust the anomaly score weight for different type of events Rare, hot, cold, detection alert, new pattern, critical |
| multi_line_flag | Whether to enable/disable Multi-line processing.
Default value: false To enable the regex multiline flag |
| nlp_flag | Whether to enable/disable NLP.
Default value:false This one is deprecated. |
| pretty_json_convertor_flag | Pretty JSON convertor flag.
Default value: false Enable this the system will reform the invalid json data into valid one |
Incident & Root Cause Analysis
| Argument | Description |
| incident_prediction_window | A configuration for Metric and Log projects that determines the “look-ahead” time for the system’s predictive analytics engine.
|
| min_incident_prediction_window | A configuration used to set a lower bound on the predictive alerting time for both Metric and Log projects.
|
| incident_prediction_event_limit | A configuration used to cap the quantity of predicted incidents for Metric and Log projects.
It sets a numerical limit on the maximum number of predicted incidents that the system will track, display, or alert on within a single processing window.
|
| incident_relation_search_window | A configuration for Metric and Log projects that manages how the system links predicted incidents to actual detected events.
|
| root_cause_count_threshold | A configuration for Metric and Log projects that controls the breadth of the system’s Root Cause Analysis (RCA) results. It defines the maximum number of root cause candidates that the system will identify and present for a single anomaly or incident.
|
| root_cause_probability_threshold | A sensitivity configuration used for Root Cause Analysis (RCA) in both Metric and Log projects. It acts as a statistical filter for root cause identification.
|
| root_cause_log_message_search_range | A configuration for Log and Metric projects that defines the temporal scope for the Root Cause Analysis (RCA) engine when searching for related log messages. It specifies the time window (in minutes) surrounding an anomaly or incident during which the system should search for relevant log entries that might explain the root cause.
|
| root_cause_rank_setting | a configuration for Metric and Log projects that controls the internal algorithm used to prioritize and sort identified root causes.
While other settings filter root causes by probability or count, this setting determines the ranking logic itself.
|
| maximum_root_cause_result_size | A configuration for Metric and Log projects that sets a hard limit on the amount of Root Cause Analysis (RCA) data returned or displayed.
It defines the absolute maximum number of root cause entries that the system will process and present to the user.
|
| avg_per_incident_downtime_cost | A financial configuration used to quantify the business impact of individual incidents within a project. It allows administrators to assign a flat monetary value to every incident or anomaly that occurs in a project.
|
| causal_prediction_setting | A configuration for Metric and Log projects that determines the scope and complexity of the causal analysis used for incident prediction.It defines the strategy the system uses to find causal relationships between different components. It specifically controls whether the system looks for relationships within a single project, across different projects, or both.
Options:
|
| causal_min_delay | A configuration for Metric and Log projects that defines a temporal constraint for the causal analysis engine.It sets the minimum time difference (delay) required between a “cause” event and an “effect” event for the system to consider them a valid causal pair.
|
| normal_event_causal_flag | (For Log Project only)
A configuration for Log projects that controls the exhaustiveness of the data used during causal analysis and Root Cause Analysis (RCA). It determines whether “normal” log events—those that are not flagged as anomalies—should be included as potential candidates when searching for the root cause of an incident.
|
Prediction Rules
| Argument | Description |
| prediction_count_threshold | A configuration for Log and Metric projects that sets a minimum requirement for the volume of evidence needed to trigger a predicted incident alert.
It acts as a “frequency gate” for the predictive engine.
|
| prediction_probability_threshold | A sensitivity configuration used by the predictive engine for both Metric and Log projects.
It serves as a confidence filter for proactive incident forecasting.
|
| prediction_rule_active_condition | A configuration for Metric and Log projects that defines the prerequisite status of a causal rule before it can be used to generate a predicted incident alert. It acts as a maturity filter for the AI’s learned causal rules.
|
| prediction_rule_active_threshold | A statistical configuration for Metric and Log projects that manages the promotion of learned causal patterns into active alerting rules. It defines the minimum probability or score required for a causal rule to be promoted to “Active” status.
|
| prediction_rule_false_positive_threshold | A quality-control configuration for Metric and Log projects used to automatically disable unreliable predictive rules.
It defines the maximum allowable false-positive rate for a causal rule before the system stops using it for proactive alerting.
|
| prediction_rule_inactive_threshold | A statistical configuration for Metric and Log projects that defines the “retirement” or “demotion” criteria for established causal rules.
It acts as the lower boundary for a causal rule’s confidence score. It is the counterpart to the prediction_rule_active_threshold.
|
Instance Settings
| Argument | Description |
| instance_convert_flag | a configuration for Log projects that manages how instance identifiers (like hostnames or IP addresses) are processed and indexed.
|
| instance_down_enable | A health-monitoring configuration used for both Metric and Log projects to detect when a data source stops sending information. It toggles the “Instance Down” detection engine.
|
| show_instance_down | A UI and visualization configuration for both Metric and Log projects that controls the visibility of connectivity-related events.
It determines whether “Instance Down” events should be displayed in the project’s dashboards, anomaly timelines, and incident reports.
|
| is_grouping_by_instance | A configuration for Log projects that determines the organizational scope of log analysis and anomaly detection.It controls whether the log engine treats each instance as an independent entity or pools them together for analysis
|
| ignore_instance_for_kb | A configuration for Metric and Log projects that manages the scope of the system’s Knowledge Base (KB) matching logic. It determines whether the instance name is a required match when looking up known issues in the Knowledge Base.
|
| is_edge_brain | A configuration used to determine if the project is running in a resource-constrained “Edge” environment or a full-scale “Cloud/Brain” environment.
It acts as an environmental architectural flag that adjusts the system’s operational logic and resource consumption.
|
| is_trace_prompt | A specialized configuration for Log projects, specifically designed for monitoring and evaluating Generative AI (LLM) workflows.
It identifies the project as a Trace Prompt monitoring system. When enabled, it activates a suite of LLM-specific evaluation and observability features:
|
Advanced Settings
| Argument | Description |
| proxy | A networking configuration used primarily by Integration and Action modules (such as ServiceNow or custom Action Proxy Servers) to route outgoing traffic through a gateway.
It defines the address of a proxy server that the InsightFinder platform must use when communicating with external systems or when an “Action” (like an automated remediation script) needs to be executed on a remote server.
|
| daily_model_span | A configuration for Log and Metric projects that determines the historical range used to build a “daily” behavioral model.
It defines how many days of historical data the machine learning engine should look back on to create the baseline for “normal” behavior.
|
| min_valid_model_span | A configuration for Metric and Log projects that ensures the machine learning models have sufficient data before they are used for anomaly detection.
It defines the minimum required duration (in milliseconds) of data that must be present in a model for it to be considered “valid” and ready for production use.
|
| maximum_detection_wait_time | A configuration for Log projects that manages the balance between detection completeness and alert latency.
It defines the maximum amount of time (in minutes) the log anomaly detection engine will wait for late-arriving logs before proceeding with the analysis for a specific time window.
|
| maximum_threads | A performance configuration for Log projects that controls the parallelization of data processing tasks.
It defines the degree of parallelism the system uses when executing heavy background tasks like log training, log detection, or log replay for a specific project.
|
| multi_hop_search_level | A configuration for Metric and Log projects that determines the depth of the causal relationship search in Root Cause Analysis (RCA).
It defines the “depth” or “number of hops” the system traverses in the causal dependency graph to find a root cause.
|
| multi_hop_search_limit | A configuration for Metric and Log projects that controls the breadth of the causal relationship search during Root Cause Analysis (RCA). While multi_hop_search_level controls the depth (how many steps away), multi_hop_search_limit controls the maximum number of neighbor nodes or total candidates the system will explore at each step of that causal search.
|
| new_pattern_number_limit | A configuration for Log projects that manages the volume of newly discovered log templates.
It sets a numerical cap on the number of unique, previously unseen log patterns that the system is allowed to identify and track during a single processing interval.
|
| new_pattern_range | A configuration for Log projects that manages the suppression and “calm down” logic for newly discovered log patterns.
t defines a temporal window or suppression period for alerts triggered by new log templates.
|
| pattern_model_flag | A configuration for Log projects that determines how log patterns are learned and shared across the environment.
It toggles between Local and Global pattern modeling for your logs.
|
| large_project | is a performance and optimization configuration for both Metric and Log projects that adjusts how the system handles high-volume data.
It informs the internal processing engine that the project contains an exceptionally large number of instances or a very high data throughput. Enabling this flag triggers several optimizations:
|
| similarity_sensitivity | A core configuration for Log projects that controls the “strictness” of the log clustering engine.
It determines how similar two log messages must be for the system to group them under the same Log Template (Pattern). Values:
|
| feature_outlier_sensitivity | a configuration for Log projects that determines how aggressively the system identifies numerical data within logs as being anomalous.
In addition to analyzing message patterns, the system extracts numerical “features” from log messages (e.g., latency values, status codes, or thread counts). This setting controls the threshold for marking those values as outliers. Values:
|
| feature_outlier_threshold | A numerical configuration for Log projects that provides a fixed “cutoff” point for detecting anomalies in log-extracted numerical data.
It defines a manual override or hard limit for numerical outlier detection.
|
| training_filter | A quality-control configuration for Metric and Log projects that manages how the system generates incidents based on learned causal rules.
It acts as a historical filter for incident generation. When enabled, the system suppresses incidents that occur outside of a “known training window.”
|
| whitelist_number_limit | This setting controls how many “known safe” log patterns your project is allowed to keep track of.
Think of it like a “VIP list” for your logs. If a log message matches a pattern on this list, the system recognizes it as normal behavior and doesn’t flag it as an issue.
|
| zone_name_key | The zone_name_key setting is used to help the system understand geographic or logical locations within your log data.
It tells the AI which specific field (or “key”) in your logs contains the information about a “Zone.” A “Zone” usually refers to something like a Cloud Region (e.g., us-east-1), a Data Center (e.g., DC-01), or a specific environment area. Available Values
|
Webhook Settings
| Argument | Description |
| webhook_url | Webhook URL. |
| max_web_hook_request_size | Maximum webhook request size. |
| webhook_alert_dampening | Alert dampening for webhooks. |
| webhook_type_set_str | Type set string for webhooks. |
| webhook_black_list_set_str | Blacklist set string for webhooks. |
| webhook_critical_keyword_set_str | Critical keyword set string for webhooks. |
JSON Configuration Strings
These fields accept JSON formatted strings for complex configurations.
email_setting
A JSON object used for configuring email notifications.
Structure:
{
“enableIncidentDetectionEmailAlert”: Boolean, // Enable email alerts for incident detection
“enableIncidentPredictionEmailAlert”: Boolean, // Enable email alerts for incident prediction
“enableRootCauseEmailAlert”: Boolean, // Enable email alerts including root cause analysis
“enableAlertsEmail”: Boolean, // Enable general alerts email
“enableNotificationAW”: Boolean, // Enable notification for AI Watchtower
“onlySendWithRCA”: Boolean, // Only send alerts if RCA is available
“emailDampeningPeriod”: Integer, // Dampening period in milliseconds
“alertsEmailDampeningPeriod”: Integer, // Dampening period for alerts in milliseconds
“predictionEmailDampeningPeriod”: Integer, // Dampening period for prediction alerts in milliseconds
“awSeverityLevel”: String // Severity level for AI Watchtower notifications
}
llm_evaluation_setting
A JSON object for configuring LLM evaluation metrics.
Structure:
{
“isHallucinationEvaluation”: Boolean,
“isAnswerRelevantEvaluation”: Boolean,
“isLogicConsistencyEvaluation”: Boolean,
“isFactualInaccuracyEvaluation”: Boolean,
“isMaliciousPromptEvaluation”: Boolean,
“isToxicityEvaluation”: Boolean,
“isPiiPhiLeakageEvaluation”: Boolean,
“isTopicGuardrailsEvaluation”: Boolean,
“isToneDetectionEvaluation”: Boolean,
“isAnomalousOutliersEvaluation”: Boolean,
“showSafetyTemplate”: Boolean,
// Bias Evaluations
“isGenderBiasEvaluation”: Boolean,
“isRacialBiasEvaluation”: Boolean,
“isSocioeconomicBiasEvaluation”: Boolean,
“isCulturalBiasEvaluation”: Boolean,
“isReligiousBiasEvaluation”: Boolean,
“isPoliticalBiasEvaluation”: Boolean,
“isDisabilityBiasEvaluation”: Boolean,
“isAgeBiasEvaluation”: Boolean
}
base_value_setting
A JSON object for configuring base values and metric mappings.
Structure:
{
“isSourceProject”: Boolean, // Is this a source project
“mappingKeys”: [String/Obj], // Keys for mapping
“baseValueKeys”: [String/Obj], // Keys for base values
“metricProjects”: [String], // List of metric projects
“additionalMetricNames”: [String] // Additional metric names
}
instance_grouping_update
A JSON object for instance grouping settings.
Structure:
{
“autoFill”: Boolean // Enable auto-fill for instance grouping
}
shared_usernames
A JSON array of usernames to share the project with.
Structure:
[
“user1”,
“user2”
]
webhook_header_list
A JSON array of header objects to be included in webhook requests.
Structure:
[
{
“headerName”: “Authorization”,
“headerValue”: “Bearer token”
}
]
log_to_log_setting_list
A JSON array for configuring log-to-log transformations.
Structure:
[
{
// Transformation rules object
}
]
cdf_setting
A JSON array for configuring Conditional Data Filtering (CDF) or Component Definition File settings.
Structure:
[
// CDF objects
]
project_servicenow_settings
This configuration block is used when project_creation_config.project_cloud_type is set to ServiceNow. It defines the parameters needed for InsightFinder to connect to and retrieve data from a ServiceNow instance, allowing for updates to project-level ServiceNow settings.
| Argument | Description |
| host | The base URL of the ServiceNow instance (e.g., https://[instance].service-now.com/). |
| servicenow_user | The username for the ServiceNow account. |
| servicenow_password | The password for the ServiceNow account. |
| client_id | The OAuth client ID used for token-based authentication. |
| client_secret | The OAuth client secret is used for token-based authentication. |
| instance_field | The field in the ServiceNow record (e.g., short_description) that contains the Instance Name to be monitored in InsightFinder. |
| instance_field_regex | The regex to apply to the instance_field to extract the Instance Name. |
| timestamp_format | The Java SimpleDateFormat used to parse the timestamp field in the ServiceNow records (e.g., yyyy-MM-dd HH:mm:ss). |
| sysparm_query | An optional ServiceNow filter query (encoded string) to limit the records fetched. Default is an empty string. |
| proxy | The URL of a proxy server for InsightFinder to use when connecting to ServiceNow. Default is an empty string. |
| additional_fields | A JSON array of extra fields (strings) to be retrieved from the ServiceNow record for inclusion in the InsightFinder data stream. |
holiday_settings
List of holiday settings for the project. Each holiday defines a period that should be treated as a holiday for anomaly detection purposes.
Structure:
[
{
“name” : String,
“start_date” : String,
“end_date” : String
}
]
| Argument | Description |
| name | Name of the holiday |
| start_date | Start date of the holiday in MM-DD format (e.g., 12-25) |
| end_data | End date of the holiday in MM-DD format (e.g., 12-26) |
log_labels
Manages InsightFinder log label settings for a project.
Required Arguments
| Argument | Description |
| project_name | The name of the project to configure log labels for. |
| label_settings | List of log label settings. |
Label Setting Block
| Argument | Description |
| label_type | Type of log label (e.g., whitelist, blacklist, patternName, logSeverity, logEventID, logSession, logComponent, logTransactionID, logCustomParameter). |
| log_label_string | JSON array string of log labels, for the log is pure string (e.g., ‘[“ERROR”,”WARN”]’ or any valid regex: ‘^\d+$’).
JSON array string of log labels, for the log is json structure (e.g., ‘key=[“ERROR”,”WARN”]’ or ‘key=^\d+$’) |
json_key_settings
Set of custom JSON key extraction settings for the project. Each entry defines one JSON key to extract from log data and controls which downstream features it participates in.
| Attribute | Description |
| json_key | The JSON key path to extract from logs (e.g., “alert->core->id”). Required. |
| type | The data type of the JSON value (e.g., “string”, “number”, “JSONArray”). Required. |
| summary_setting | Include this key in summary statistics. Type: Boolean. |
| metafield_setting | Include this key in metafield settings. Type: Boolean. |
| dampening_field_setting | Include this key in dampening field settings. Type: Boolean. |
| notification_setting | Include this key in notification settings. Type: Boolean. Optional. |
| notification_setting_display_name | Display name for this key in notification settings. Type: String. Optional. |
| service_now_notification_setting | Include this key in ServiceNow notification settings. Type: Boolean. Optional. |
| service_now_notification_setting_display_name | Display name for this key in ServiceNow notifications. Type: String. Optional. |
ServiceNow Notification Templates
| Attribute | Description |
| service_now_short_description_format | Rules for short description content |
| service_now_description_format | Rules for non-key-value notification content |
l2m_settings
Set of log-to-metric (L2M) settings. Each entry maps this log project to a target metric project and specifies how log data is parsed into metric data points.
| Argument | Description |
| metric_project_name | Name of the target metric project. Required. |
| json_flag | Use JSON parsers (true) or regex parsers (false). Type: Boolean. |
| enable_mapping | Enable this L2M mapping. Type: Boolean. |
| json_parsers | List of JSON parser objects. Used when json_flag = true. See sub-block below. |
l2m_settings – json_parsers block
| Argument | Description |
| metric_value_key | JSON key path to extract the metric value from the log event. |
| operation | Parser operation type. Type: Integer. |
| aggregation_mode | Aggregation mode for combining values. Type: Integer. |
| grouping_by_component | Group metric data by component. Type: Boolean. |
| aggregation_period | Aggregation period. Type: Integer. |
| derived_value_model | Optional nested object for derived value configuration. See sub-block below. |
l2m_settings – json_parsers – derived_value_model block
| Argument | Description |
| base_value_expression | Expression for the base value. |
| actual_value_expression | Expression for the actual value. |
| operation | Derived value operation type. Type: Integer. |
| mapping_ids | List of mapping IDs (list of strings). |
insightfinder_servicenow
Manages InsightFinder ServiceNow integration.
Required Arguments
| Argument | Description |
| account | ServiceNow account username. |
| service_host | ServiceNow service host URL. |
| password | ServiceNow account password. |
| dampening_period | Dampening period in seconds. |
Optional Arguments
| Argument | Description |
| proxy | Proxy server URL. |
| app_id | Application ID. |
| app_key | Application Key. |
| auth_type | Authentication type. |
| system_names | List of system names to integrate. |
| system_ids | List of system IDs to integrate. |
| options | List of options (e.g., “Root Cause”). |
| content_option | List of content options (e.g., “SUMMARY”). |
| service_now_field | The ServiceNow ticket field where InsightFinder writes incident analysis data (e.g., “u_probable_cause”). Type: String. |
| content_source | Source used to populate the ServiceNow ticket content (e.g., “other”). Type: String. |
| trigger_window_in_mills | Time window in milliseconds controlling when a new ServiceNow ticket is created for a recurring incident. Type: Integer. |
| enable_feedback_collect | Enable collecting feedback from resolved ServiceNow tickets back into InsightFinder. Type: Boolean. |
| ticket_created_by_source_key | ServiceNow field name used to identify the ticket creator (e.g., “opened_by”). Type: String. |
| ticket_created_by_source_value | Expected value of ticket_created_by_source_key that identifies InsightFinder-created tickets (e.g., “Insight Finder Platform”). Type: String. |
| configuration_item | Default ServiceNow CMDB configuration item applied to tickets when no project-level override is set. Type: String. |
project_configs Block
Optional map of project-specific ServiceNow ticket settings. The map key is the InsightFinder project name. Each entry can override the default configuration item and control which ticket operations are enabled for that project.
| Argument | Description |
| enable_ticket_creation | Enable automatic creation of ServiceNow tickets for incidents in this project. Type: Boolean. |
| enable_ticket_update | Enable updating existing ServiceNow tickets when new incident data arrives. Type: Boolean. |
| enable_incident_consolidation_info_update | Enable updating tickets with incident consolidation information. Type: Boolean. |
| enable_incident_resolve_update | Enable updating tickets when an incident is resolved. Type: Boolean. |
| configuration_item | ServiceNow CMDB configuration item for this project. Overrides the top-level configuration_item. Type: String. |
insightfinder_system_settings
Manages InsightFinder system-level settings including knowledge base configuration, notification / alert settings, and miscellaneous system framework settings. This resource targets a system (not a project). Deleting the resource from Terraform removes it from state only; settings are left unchanged on the server.
Required Arguments
| Argument | Description |
| system_name | Display name of the system. Used to resolve the system ID. Forces replacement when changed. |
knowledgebase_settings Block
Optional block. Controls the global Knowledge Base (KB) and Incident Prediction engine for the system.
knowledgebase_settings – Global KB Fields
| Argument | Description |
| enable_global_knowledge_base | Enable the global knowledge base for the system. Type: Boolean. |
| composite_valid_threshold | Composite valid threshold in milliseconds. Type: Integer. |
| timeline_top_k | Number of top timeline entries to retain. Type: Integer. |
| enable_ignore_instance_prediction | When true, the KB ignores instance-level prediction data. Type: Boolean. |
| prediction_source | Prediction source type (0 = default, 1 = custom). Type: Integer. |
| share_system_type | Share system type for the KB. Type: Integer. |
| action_execution_time | Action execution time in minutes. Type: Integer. |
| auto_fix_validation_window | Validation window used by the auto-fix feature. Type: Integer. |
| filter_self_to_self | Filter out self-to-self KB entries. Type: Boolean. |
| rule_source_type | Rule source type (0 = default). Type: Integer. |
| satellite_system_set | JSON array of satellite systems linked to this system’s knowledge base. Each entry requires a systemPartitionKey object (userName, systemName, envName) and a replay boolean. Example: jsonencode([{systemPartitionKey={userName=”u”,systemName=”<id>”,envName=”All”},replay=false}]) |
knowledgebase_settings – Incident Prediction Fields
| Argument | Description |
| rule_active_threshold | Min probability to promote a causal rule to Active status (0.0-1.0). Type: Float. |
| rule_inactive_threshold | Probability below which a rule is demoted (0.0-1.0). Must be <= rule_active_threshold. Type: Float. |
| rule_active_condition | Prerequisite a rule must meet before generating alerts (0 = unfiltered, 1 = verified only). Type: Integer. |
| false_positive_tolerance | False positive count tolerated before a rule is deactivated. Type: Integer. |
| kb_training_length | Length of the KB training window in milliseconds. Type: Integer. |
| tolerance | Tolerance value for incident prediction calculations. Type: Float. |
| enable_insensitive_rule_matching | Enable case-insensitive rule matching in the KB. Type: Boolean. |
notifications_settings Block
Optional block. Controls all notification and alert email settings for the system. Persisted via /api/external/v2/healthviewsetting plus separate sub-APIs for system-down, instance-down, and insights report notifications.
notifications_settings – Health View / General Fields
| Argument | Description |
| order | Display order for the system in the health view dashboard. Type: Integer. |
| hide_flag | Hide this system from the health view. Type: Boolean. |
| aggregation_interval | Aggregation interval in minutes for health view metrics. Type: Integer. |
| enable_splunk_export | Enable exporting system data to Splunk. Type: Boolean. |
| incident_count_threshold | JSON map of project names (format: “ProjectName@username”) to incident count thresholds. Example: jsonencode({“MyProject@admin”: 5}) or jsonencode({}) to clear. |
| assignment_map | JSON map of zone/component keys to assignee lists. Each value can contain emailAssignees, jiraAssignees, serviceNowAssignees arrays. Example: jsonencode({“{“zone”:”All”,”component”:”All”}”: {“emailAssignees”: [“user@example.com”]}}) |
| alert_health_score | Health score threshold (0.0-1.0) below which an alert is triggered. Type: Float. |
| alert_frequency | Alert frequency setting. Type: Integer. |
| incident_dampening_window | Dampening window for incident notifications in milliseconds. Type: Integer. |
| ticket_open_time | Time window (ms) to keep a ticket open after an incident resolves. Type: Integer. |
| component_level_incident_consolidation | Enable component-level incident consolidation. Type: Boolean. |
| enabled_consolidation_algorithms | List of consolidation algorithm names to enable. Valid values: “derivedIncidents”, “rcaChain”, “contentBased”, “metricInstanceTimestamp”. Type: List of Strings. |
notifications_settings – Email Alert Fields
| Argument | Description |
| prediction_email | Email address for incident prediction notifications. Type: String. |
| email_dampening_period | Dampening period for health alert emails in milliseconds. Type: Integer. |
| alerts_email_dampening_period | Dampening period for general alert emails in milliseconds. Type: Integer. |
| prediction_email_dampening_period | Dampening period for prediction emails in milliseconds. Type: Integer. |
| enable_system_down_email_alert | Enable email alert when the system is down. Type: Boolean. |
| only_send_with_rca | Only send notifications when root cause analysis data is available. Type: Boolean. |
| enable_incident_prediction_email_alert | Enable email alert for incident predictions. Type: Boolean. |
| enable_incident_detection_email_alert | Enable email alert for incident detections. Type: Boolean. |
| enable_alerts_email | Enable general alert emails. Type: Boolean. |
| enable_health_email_alert | Enable health score email alerts. Type: Boolean. |
| enable_root_cause_email_alert | Enable email alerts including root cause analysis results. Type: Boolean. |
| alert_email | Email address for general alert notifications. Type: String. |
| health_alert_email | Email address for health alert notifications. Type: String. |
| incident_detection_email | Email address for incident detection notifications. Type: String. |
| root_cause_email | Email address for root cause analysis notifications. Type: String. |
notifications_settings – system_down_notification Block
Optional nested block. Managed via a dedicated system-down API.
| Argument | Description |
| enable_system_down_email_alert | Enable email alert when the system is down. Type: Boolean. |
| email_dampening_period | Dampening period for system-down emails in milliseconds. Type: Integer. |
| email_set | List of email addresses to notify when the system is down. Type: List of Strings. |
notifications_settings – project_level_dampening_windows Block
Optional set of nested blocks. Each block overrides the system-level incident dampening window for a specific source to target project pair.
| Argument | Description |
| source_project | The source project name. Required. |
| target_project | The target project name. Required. |
| source_customer | Username of the source project owner. Defaults to the provider username. Optional. |
| target_customer | Username of the target project owner. Defaults to the provider username. Optional. |
| duration | Dampening duration in milliseconds. Required. |
miscellaneous_settings Block
Optional block. Controls miscellaneous system framework settings.
| Argument | Description |
| healthview_longterm | Enable long-term storage mode for the system health view. Type: Boolean. |
| should_auto_share | Enable automatic sharing of system data. Type: Boolean. |
| rootcause_reverse_entry_filter_threshold | Threshold (0-100) for the root cause reverse entry filter. Type: Integer. |
| enable_composite_timeline | Enable the composite timeline view for the system. Type: Boolean. |
jwt_config
Manages InsightFinder JWT configuration for a system.
Required Arguments
| Argument | Description |
| system_name | The name of the system to configure JWT for. |
| jwt_secret | The JWT secret token (minimum 6 characters). |
Optional Arguments
| Argument | Description |
| jwt_type | The JWT type (Default: 1 for system-level JWT). |
insightfinder_metric_project
Manages an InsightFinder metric project. This resource is purpose-built for metric data and provides metric-specific settings (baseline detection, gap filling, KPI prediction, etc.) in addition to the general settings shared with insightfinder_project.
Required Arguments
| Argument | Description |
| project_name | The unique name of the metric project. |
| system_name | The system name this project belongs to. |
| project_creation_config | A block defining project creation parameters (see below). |
Project Creation Config Block
| Argument | Description |
| data_type | The type of data. Typically “Metric”. |
| instance_type | The instance type (e.g., “PrivateCloud”, “LogToMetric”). |
| project_cloud_type | The cloud type for the project (e.g., “PrivateCloud”, “LogToMetric”). |
| insight_agent_type | The InsightFinder agent type (e.g., “Custom”). Optional. |
Common Optional Arguments (shared with insightfinder_project)
The following arguments behave identically to the same-named arguments on insightfinder_project. Refer to that section for full descriptions.
| Argument | Description |
| project_display_name | Display name for the project. |
| project_time_zone | Timezone (default: UTC). |
| sampling_interval | Sampling interval in seconds. |
| c_value | C value for anomaly sensitivity (typically 2-5). |
| p_value | P value for anomaly probability (0.0-1.0). |
| retention_time | Data retention time in days. |
| ubl_retention_time | UBL retention time in days. |
| training_filter | Training filter flag. |
| enable_new_alert_email | Enable new alert email notifications. |
| large_project | Optimize processing for large-scale data. |
| new_pattern_range | Suppression window for new pattern alerts (sampling intervals). |
| proxy | Proxy server URL for external connections. |
| enable_anomaly_score_escalation | Enable anomaly score escalation. |
| escalation_anomaly_score_threshold | Threshold for anomaly score escalation. |
| ignore_anomaly_score_threshold | Ignore anomalies with a score below this threshold. |
| enable_stream_detection | Enable streaming detection pipeline. |
| ignore_instance_for_kb | Ignore instance name when matching KB entries. |
| show_instance_down | Show instance-down incidents in the UI. |
| instance_down_enable | Enable instance-down detection. |
| alert_hourly_cost | Hourly monetary cost for alerts (e.g., USD). |
| alert_average_time | Smoothing window for alert average time calculations. |
| avg_per_incident_downtime_cost | Average monetary cost per incident downtime. |
| incident_prediction_window | Look-ahead window for incident prediction (minutes). |
| min_incident_prediction_window | Minimum incident prediction window (minutes). |
| incident_relation_search_window | Window for linking predicted to actual incidents (minutes). |
| incident_prediction_event_limit | Max predicted incidents tracked per processing window. |
| root_cause_count_threshold | Max root cause candidates returned per incident. |
| root_cause_probability_threshold | Min probability for a root cause candidate (0.0-1.0). |
| root_cause_log_message_search_range | Search range for RCA log messages (minutes). |
| causal_prediction_setting | Causal analysis scope (0=all, 1=within project, 2=cross project). |
| root_cause_rank_setting | Ranking algorithm for root causes. |
| maximum_root_cause_result_size | Hard limit on RCA entries returned. |
| multi_hop_search_level | Depth of causal graph traversal. |
| multi_hop_search_limit | Max neighbors explored at each causal hop (string-encoded integer). |
| prediction_count_threshold | Min evidence count to trigger a prediction alert. |
| prediction_probability_threshold | Min confidence for prediction alerts (0.0-1.0). |
| prediction_rule_active_condition | Maturity filter for causal rules used in prediction. |
| prediction_rule_active_threshold | Min probability to promote a rule to Active (0.0-1.0). |
| prediction_rule_false_positive_threshold | Max false-positive count before disabling a rule. |
| prediction_rule_inactive_threshold | Probability below which a rule is demoted (0.0-1.0). |
| min_valid_model_span | Min data duration (ms) required before a model is used. |
| webhook_url | Webhook URL. |
| max_web_hook_request_size | Maximum webhook request size. |
| webhook_alert_dampening | Alert dampening period for webhooks (ms). |
| webhook_black_list_set_str | Blacklist pattern set for webhooks (JSON string). |
| webhook_critical_keyword_set_str | Critical keyword set for webhooks (JSON string). |
| webhook_type_set_str | Type set for webhooks (JSON string). |
| email_setting | Email notification settings (JSON). Same structure as insightfinder_project. |
| instance_grouping_update | Instance grouping update settings (JSON, e.g., {“autoFill”: false}). |
| shared_usernames | JSON array of usernames to share the project with. |
| webhook_header_list | JSON array of webhook header objects ({headerName, headerValue}). |
| linked_log_projects | JSON array of log project names linked to this metric project for RCA. |
| holiday_settings | List of holiday settings (same structure as insightfinder_project). |
Metric-Specific Optional Arguments
| Argument | Description |
| high_ratio_c_value | High-ratio C value for anomaly detection. Used for metrics that change dramatically. Type: Integer. |
| maximum_hint | Maximum hint value for anomaly detection. Type: Integer. |
| dynamic_baseline_detection_flag | Enable dynamic baseline detection instead of static thresholds. Type: Boolean. |
| positive_baseline_violation_factor | Multiplier for detecting positive (upward) baseline violations. Type: Float. |
| negative_baseline_violation_factor | Multiplier for detecting negative (downward) baseline violations. Type: Float. |
| enable_period_anomaly_filter | Filter out anomalies that follow a known periodic pattern. Type: Boolean. |
| enable_ubl_detect | Enable UBL (Unsupervised Baseline Learning) detection. Type: Boolean. |
| enable_cumulative_detect | Enable cumulative anomaly detection mode. Type: Boolean. |
| enable_component_level_detection | Enable anomaly detection at the component level. Type: Boolean. |
| prediction_training_data_length | Historical data length (ms) for training the prediction model. Type: Integer. |
| prediction_correlation_sensitivity | Sensitivity for detecting metric correlations in prediction (0.0-1.0). Type: Float. |
| enable_kpi_prediction | Enable KPI prediction. Type: Boolean. |
| instance_down_threshold | Silence duration (ms) before an instance is considered down. Type: Integer. |
| instance_down_report_number | Number of instances that must be down before an alert is generated. Type: Integer. |
| model_span | Data span (ms) used by the detection model. Type: Integer. |
| enable_metric_data_prediction | Enable forward prediction of metric data values. Type: Boolean. |
| enable_baseline_detection_double_verify | Require a second verification pass before flagging a baseline deviation. Type: Boolean. |
| enable_fill_gap | Enable automatic gap-filling for missing metric data points. Type: Boolean. |
| enable_store_filled_gap | Persist gap-filled data points to storage. Type: Boolean. |
| gap_filling_training_data_length | Historical data length (ms) used to train the gap-filling model. Type: Integer. |
| pattern_id_generation_rule | Rule used to generate internal pattern IDs. Type: Integer. |
| anomaly_gap_tolerance_count | Consecutive missing data points tolerated before counted as anomaly. Type: Integer. |
| filter_by_anomaly_in_baseline_generation | Exclude anomalous data when building the baseline model. Type: Boolean. |
| baseline_duration | Duration (ms) of the window used to calculate the baseline. Type: Integer. |
| anomaly_dampening | Dampening period (ms) between consecutive anomaly alerts for the same metric. Type: Integer. |
| instance_down_ratio_threshold | Fraction (0.0-1.0) of instances that must be down to trigger an alert. Type: Float. |
| component_name_auto_overwrite | Automatically overwrite component names with values from the data source. Type: Boolean. |
| component_metric_setting_overall_model_list | JSON array specifying the overall model list for component-level metric settings. |
Data Sources
insightfinder_project
Fetches an InsightFinder project.
| Argument | Description |
| project_name | (Required) The name of the project to fetch. |
| project_display_name | (Computed) The display name for the project. |
| c_value | (Computed) The C value. |
| p_value | (Computed) The P value. |
insightfinder_systems
Fetches the list of systems from InsightFinder.
| Attribute | Description |
| systems | List of systems, each containing system_name and system_id. |
From the Blog
See how InsightFinder helps your team deliver reliable services across every layer of the stack
Take InsightFinder AI for a no-obligation test drive. We’ll provide you with a detailed report on your outages to uncover what could have been prevented.