Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
clouddrove-ci committed Apr 6, 2023
1 parent 68c2b8e commit a1b3da0
Showing 1 changed file with 22 additions and 11 deletions.
33 changes: 22 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,19 +81,18 @@ Here are some examples of how you can use this module in your inventory structur
resource_group_name = module.resource_group.resource_group_name
location = module.resource_group.resource_group_location
# workspace_id = module.log-analytics.workspace_id
application_type = "web"
daily_data_cap_in_gb = 30
application_type = "web"
##web test
web_test_enable = false
kind = "ping"
frequency = 300
timeout = 60
monitored_enabled = true
retry_enabled = true
geo_locations = ["us-ca-sjc-azr", "us-tx-sn1-azr", "us-il-ch1-azr", "us-va-ash-azr", "us-fl-mia-edge"]
list_of_test_urls = ["https://www.google.com", ]
web_test_name = ["google", ]
web_test_enable = true
kind = "ping"
frequency = 300
timeout = 60
list_of_test_urls = ["https://www.google.com", ]
web_test_name = ["google", ]
#### enable diagnostic setting
log_analytics_workspace_id = module.log-analytics.workspace_id
}
```

Expand All @@ -106,15 +105,22 @@ Here are some examples of how you can use this module in your inventory structur

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| Metric\_enable | Is this Diagnostic Metric enabled? Defaults to true. | `bool` | `true` | no |
| application\_insights\_config | Specifies the type of Application Insights to create. Valid values are ios for iOS, java for Java web, MobileCenter for App Center, Node.JS for Node.js, other for General, phone for Windows Phone, store for Windows Store and web for ASP.NET. Please note these values are case sensitive; unmatched values are treated as ASP.NET by Azure. Changing this forces a new resource to be created. | `string` | `"web"` | no |
| application\_type | Required) Specifies the type of Application Insights to create. Valid values are ios for iOS, java for Java web, MobileCenter for App Center, Node.JS for Node.js, other for General, phone for Windows Phone, store for Windows Store and web for ASP.NET. Please note these values are case sensitive; unmatched values are treated as ASP.NET by Azure. Changing this forces a new resource to be created. | `string` | `""` | no |
| attributes | Additional attributes (e.g. `1`). | `list(string)` | `[]` | no |
| business\_unit | Top-level division of your company that owns the subscription or workload that the resource belongs to. In smaller organizations, this tag might represent a single corporate or shared top-level organizational element. | `string` | `"Corp"` | no |
| category | The name of a Diagnostic Log Category Group for this Resource. | `string` | `null` | no |
| daily\_data\_cap\_in\_gb | Specifies the Application Insights component daily data volume cap in GB. | `number` | `30` | no |
| daily\_data\_cap\_notifications\_disabled | Optional) Specifies if a notification email will be send when the daily data volume cap is met. | `bool` | `false` | no |
| description | Purpose/user defined descriptive test for this WebTest. | `string` | `""` | no |
| diagnostic\_log\_days | The number of days for which this Retention Policy should apply. | `number` | `"90"` | no |
| diagnostic\_setting\_enable | n/a | `bool` | `true` | no |
| disable\_ip\_masking | By default the real client IP is masked as 0.0.0.0 in the logs. Use this argument to disable masking and log the real client IP. Defaults to false. | `bool` | `false` | no |
| enabled | Set to false to prevent the module from creating any resources. | `bool` | `true` | no |
| environment | Environment (e.g. `prod`, `dev`, `staging`). | `string` | `""` | no |
| eventhub\_authorization\_rule\_id | Specifies the ID of an Event Hub Namespace Authorization Rule used to send Diagnostics Data. | `string` | `null` | no |
| eventhub\_name | Specifies the name of the Event Hub where Diagnostics Data should be sent. | `string` | `null` | no |
| extra\_tags | Additional tags (e.g. map(`BusinessUnit`,`XYZ`). | `map(string)` | `{}` | no |
| footer | n/a | `string` | `"</Items></WebTest>"` | no |
| force\_customer\_storage\_for\_profiler | Should the Application Insights component force users to create their own storage account for profiling? Defaults to false. | `bool` | `false` | no |
Expand All @@ -128,15 +134,20 @@ Here are some examples of how you can use this module in your inventory structur
| list\_of\_test\_urls | List of URLs to put in the availability tests. Example: ["https://test1.example.com", "https://test2.example.com/app"] | `list(string)` | `[]` | no |
| local\_authentication\_disabled | (Optional) Disable Non-Azure AD based Auth. Defaults to false. | `bool` | `false` | no |
| location | (Required) Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created. | `string` | `""` | no |
| log\_analytics\_destination\_type | Possible values are AzureDiagnostics and Dedicated, default to AzureDiagnostics. When set to Dedicated, logs sent to a Log Analytics workspace will go into resource specific tables, instead of the legacy AzureDiagnostics table. | `string` | `"AzureDiagnostics"` | no |
| log\_analytics\_workspace\_id | n/a | `string` | `null` | no |
| log\_enabled | Is this Diagnostic Log enabled? Defaults to true. | `string` | `true` | no |
| managedby | ManagedBy, eg 'CloudDrove' or 'AnmolNagpal'. | `string` | `"anmol@clouddrove.com"` | no |
| monitored\_enabled | n/a | `bool` | `true` | no |
| name | Name (e.g. `app` or `cluster`). | `string` | `""` | no |
| parse\_deps | Retrieve resources that are linked to by the test URL as part of the web test. Valid values are "True" or "False". Default value is "False". | `string` | `"false"` | no |
| repository | Terraform current module repo | `string` | `""` | no |
| resource\_group\_name | The name of the resource group in which to create the network security group. | `string` | n/a | yes |
| retention\_in\_days | Specifies the retention period in days. Possible values are 30, 60, 90, 120, 180, 270, 365, 550 or 730. Defaults to 90. | `number` | `90` | no |
| retention\_policy\_enabled | Is this Retention Policy enabled? | `bool` | `false` | no |
| retry\_enabled | Allow for retries should this WebTest fail. | `bool` | `true` | no |
| sampling\_percentage | Specifies the percentage of the data produced by the monitored application that is sampled for Application Insights telemetry. | `number` | `100` | no |
| storage\_account\_id | The ID of the Storage Account where logs should be sent. | `string` | `null` | no |
| tags | A mapping of tags to assign to the resource. | `map(string)` | `{}` | no |
| test\_body | WebTest XML Request body. If overridden, make sure to retain all the string format() parameters needed by the local variable calculations. | `string` | `"<Request Method=\"GET\" Guid=\"%s\" Version=\"1.1\" Url=\"%s\" ThinkTime=\"0\" Timeout=\"300\" ParseDependentRequests=\"PARSEDEPS\" FollowRedirects=\"True\" RecordResult=\"True\" Cache=\"True\" ResponseTimeGoal=\"0\" Encoding=\"utf-8\" ExpectedHttpStatusCode=\"200\" ExpectedResponseUrl=\"\" ReportingName=\"\" IgnoreHttpStatusCode=\"False\" />"` | no |
| timeout | Seconds until this WebTest will timeout and fail. Default is 30. | `number` | `30` | no |
Expand Down

0 comments on commit a1b3da0

Please sign in to comment.