collectsfdata.schema.json

{
  "definitions": {},
  "$schema": "http://json-schema.org/draft-07/schema#",
  "id": "https://raw.githubusercontent.com/microsoft/CollectServiceFabricData/master/configurationFiles/collectsfdata.schema.json",
  "type": "object",
  "title": "CollectSFData Schema",
  "required": [
    "EndTimeStamp",
    "GatherType",
    "StartTimeStamp"
  ],
  "properties": {
    "AzureClientCertificate": {
      "$id": "#/properties/AzureClientCertificate",
      "type": "string",
      "title": "AzureClientCertificate",
      "description": "client certificate used in authorization to azure.",
      "required": [
      ],
      "default": null,
      "examples": [
        null,
        "{{secret name in key vault}}",
        "star-sfcluster-com",
        "{{thumb print}}",
        "D60F1AA6632B4C2A385879C227387359535B77DE",
        "{{subject name}}",
        "sfcluster.com",
        "{{file name}}",
        "star-sfcluster.pfx",
        "{{base64 string}}",
        "MIIV3AIBAzCCF...Jsc="
      ],
      "pattern": "^([a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12})$"
    },
    "AzureClientId": {
      "$id": "#/properties/AzureClientId",
      "type": "string",
      "title": "AzureClientId",
      "description": "azure application id or user managed id for non-interactive execution",
      "required": [
      ],
      "default": null,
      "examples": [
        null,
        "4c09d2a3-aed8-494a-8804-6ebfd5e3a022"
      ],
      "pattern": "^([a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12})$"
    },
    "AzureKeyVault": {
      "$id": "#/properties/AzureKeyVault",
      "type": "string",
      "title": "AzureKeyVault",
      "description": "azure keyvault base uri if downloading client certificate from key vault.",
      "default": null,
      "examples": [
        null,
        "https://{{key vault name}}.vault.azure.net/"
      ],
      "pattern": "^(.+)$"
    },
    "AzureResourceGroup": {
      "$id": "#/properties/AzureResourceGroup",
      "type": "string",
      "title": "AzureResourceGroup",
      "description": "used for creation / recreation of Log Analytics Workspace",
      "required": [
        "AzureResourceGroupLocation"
      ],
      "default": null,
      "examples": [
        null,
        "laResourceGroup"
      ],
      "pattern": "^(\\w+)$"
    },
    "AzureResourceGroupLocation": {
      "$id": "#/properties/AzureResourceGroupLocation",
      "type": "string",
      "title": "AzureResourceGroupLocation",
      "description": "azure MSAL region auth hint and azure region for creation / recreation of Log Analytics Workspace",
      "default": null,
      "examples": [
        null,
        "eastus"
      ],
      "pattern": "^(.+)$"
    },
    "AzureSubscriptionId": {
      "$id": "#/properties/AzureSubscriptionId",
      "type": "string",
      "title": "AzureSubscriptionId",
      "description": "azure subscription id guid for certain non-default azure operations",
      "default": null,
      "examples": [
        null,
        "123456578-1234-1234-1234-123456789012"
      ],
      "pattern": "^([a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12})$"
    },
    "AzureTenantId": {
      "$id": "#/properties/AzureTenantId",
      "type": "string",
      "title": "AzureTenantId",
      "description": "azure tenant id guid for certain non-default azure operations",
      "default": "common",
      "examples": [
        "common",
        null,
        "123456578-1234-1234-1234-123456789012"
      ],
      "pattern": "^([a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12})$"
    },
    "CacheLocation": {
      "$id": "#/properties/CacheLocation",
      "type": "string",
      "title": "CacheLocation",
      "description": "local device cache source / destination path if UseMemoryStream = false",
      "default": null,
      "examples": [
        null,
        "c:\\temp"
      ],
      "pattern": "^(.+)$"
    },
    "CheckForUpdates": {
      "$id": "#/properties/CheckForUpdates",
      "type": "integer",
      "title": "CheckForUpdates",
      "description": "0-disabled, else check for new utility updates every n days",
      "default": 30,
      "enum": [
        0,
        1,
        2,
        3,
        4,
        5
      ],
      "examples": [
        0,
        1,
        2,
        3,
        4,
        5
      ],
      "pattern": "^(\\d{0,3})$"
    },
    "ContainerFilter": {
      "$id": "#/properties/ContainerFilter",
      "type": "string",
      "title": "ContainerFilter",
      "description": "optional container name needed in non-default deployments with multiple clusters using same storage account",
      "default": null,
      "examples": [
        null,
        "fabriclogs-e5106617-a3aa-4211-a802-e2729597d5fe"
      ],
      "pattern": "^(.+)$"
    },
    "DatabasePersistence": {
      "$id": "#/properties/DatabasePersistence",
      "type": "boolean",
      "title": "DatabasePersistence",
      "description": "true to create a local persistent database.",
      "default": false,
      "examples": [
        false,
        true
      ]
    },
    "DatabasePersistencePath": {
      "$id": "#/properties/DatabasePersistencePath",
      "type": "string",
      "title": "DatabasePersistencePath",
      "description": "local device database path if a local kusto url is provided.",
      "default": null,
      "examples": [
        null,
        "@'C:\\kustodata\\MyDatabaseName\\md',@'C:\\kustodata\\MyDatabaseName\\data'"
      ],
      "pattern": "^(.+)$"
    },
    "DeleteCache": {
      "$id": "#/properties/DeleteCache",
      "type": "boolean",
      "title": "DeleteCache",
      "description": "true to clean CacheLocation at utility exit.",
      "default": false,
      "examples": [
        false,
        true
      ]
    },
    "EndTimeStamp": {
      "$id": "#/properties/EndTimeStamp",
      "type": "string",
      "title": "EndTimeStamp",
      "description": "required in specified format",
      "default": "yyyy-MM-dd HH:mm +00:00",
      "examples": [
        "07/06/2019 23:30:00 +00:00",
        "M/d/yy H:mm:ss zzz",
        "M/d/yyyy H:mm:ss zzz",
        "yy/M/d H:mm:ss zzz",
        "yyyy/M/d H:mm:ss zzz",
        "M-d-yy H:mm:ss zzz",
        "M-d-yyyy H:mm:ss zzz",
        "yy-M-d H:mm:ss zzz",
        "yyyy-M-d H:mm:ss zzz"
      ],
      "pattern": "^([0-9]{1,4}(\\/|-)[0-9]{1,2}(\\/|-)[0-9]{1,4} [0-9]{1,2}:[0-9]{1,2}(:[0-9]{1,2}|) (-|\\+)[0-9]{1,2}:[0-9]{1,2})$"
    },
    "EtwManifests": {
      "$id": "#/properties/EtwManifests",
      "type": "string",
      "title": "EtwManifests",
      "description": "local device manifest cache source path",
      "default": "./manifests",
      "examples": [
        null,
        "./manifests",
        "c:\\temp"
      ],
      "pattern": "^(.+)$"
    },
    "FileUris": {
      "$id": "#/properties/FileUris",
      "type": "array",
      "title": "FileUris",
      "description": "optional string array parameter to configure specific files for upload",
      "default": [],
      "items": {
        "type": "string",
        "examples": [
          "C:\\temp\\f45f24746c42cc2a6dd69da9e7797e2c_fabric_traces_7.2.457.9590_132610909762170249_865_00637532483045019565_0000000000.dtr.zip",
          "C:\\temp\\1.dtr.zip",
          "\\share\\temp\\2.dtr",
          "D:/temp/1.blg",
          "https://sflogsxxxxxxxxxxxxxx.file.core.windows.net/fabriclogs-123456578-1234-1234-1234-123456789012/_nt0_2/Fabric/bc4316ec4b0814dcc367388a46d9903e_fabric_traces_7.2.457.9590_132610909242411002_3_00637522276995522478_0000000000.dtr.zip"
        ],
        "pattern": "^([a-zA-Z]:|\\\\\\\\|http.:).+?\\..{3,4}$",
        "uniqueItems": true
      },
      "additionalItems": false
    },
    "GatherType": {
      "$id": "#/properties/GatherType",
      "type": "string",
      "title": "GatherType",
      "description": "required value. see examples",
      "default": "trace",
      "enum": [
        "trace",
        "counter",
        "setup",
        "table",
        "exception",
        "sfextlog",
        "any"
      ],
      "examples": [
        "trace",
        "counter",
        "setup",
        "table",
        "exception",
        "sfextlog",
        "any"
      ],
      "pattern": "^(trace|counter|setup|table|exception|sfextlog|any)$"
    },
    "KustoCluster": {
      "$id": "#/properties/KustoCluster",
      "type": "string",
      "title": "KustoCluster",
      "description": "ingest url see example",
      "required": [
        "KustoTable"
      ],
      "default": "https://ingest-{{kusto cluster}}.{{optional location}}.kusto.windows.net/{{kusto database}}",
      "examples": [
        "https://ingest-{{kusto cluster}}.{{optional location}}.kusto.windows.net/{{kusto database}}",
        "https://ingest-sfcluster.eastus.kusto.windows.net/sflogdatabase",
        "https://ingest-sfcluster.kusto.windows.net/sflogdatabase",
        "http://localhost:{{port}}/{{databaseName}}",
        "http://localhost:8080/MyDatabaseName"
      ],
      "pattern": "^(https://ingest-.+?.kusto.windows.net/.+)|(http://localhost:\\d{1,5}/.+)$"
    },
    "KustoCompressed": {
      "$id": "#/properties/KustoCompressed",
      "type": "boolean",
      "title": "KustoCompressed",
      "description": "true to compress file before posting to kusto ingest to save network bandwidth",
      "default": true,
      "examples": [
        false,
        true
      ]
    },
    "KustoPurge": {
      "$id": "#/properties/KustoPurge",
      "type": "string",
      "title": "KustoPurge",
      "description": "'true' to delete data from existing table in 'KustoTable', 'list' to list current kusto tables, or table name to purge/drop.",
      "default": null,
      "examples": [
        null,
        "true",
        "list",
        "trace_jagilber_00000000000001",
        "'list jagilber'"
      ],
      "pattern": "^(true|list.*)$"
    },
    "KustoRecreateTable": {
      "$id": "#/properties/KustoRecreateTable",
      "type": "boolean",
      "title": "KustoRecreateTable",
      "description": "true to recreate / drop kusto table before ingest.",
      "default": false,
      "examples": [
        false,
        true
      ]
    },
    "KustoTable": {
      "$id": "#/properties/KustoTable",
      "type": "string",
      "title": "KustoTable",
      "description": "name of kusto table for ingestion. table name will be prepended with GatherType",
      "default": null,
      "examples": [
        "cluster1_190707"
      ],
      "pattern": "^(.+)$"
    },
    "KustoUseBlobAsSource": {
      "$id": "#/properties/KustoUseBlobAsSource",
      "type": "boolean",
      "title": "KustoUseBlobAsSource",
      "description": "true to ingest dtr.zip logs directly from cluster storage account. available in service fabric 6.5",
      "default": true,
      "examples": [
        false,
        true
      ]
    },
    "KustoUseIngestMessage": {
      "$id": "#/properties/KustoUseIngestMessage",
      "type": "boolean",
      "title": "KustoUseIngestMessage",
      "description": "true to use Kusto (service bus) messaging for success and failure ingests",
      "default": false,
      "examples": [
        false,
        true
      ]
    },
    "List": {
      "$id": "#/properties/List",
      "type": "boolean",
      "title": "List",
      "description": "true to enumerate blobs from storage account but not download",
      "default": false,
      "examples": [
        false,
        true
      ]
    },
    "LocalPath": {
      "$id": "#/properties/LocalPath",
      "type": "string",
      "title": "LocalPath",
      "description": "local device path containing source trace files for ingestion.",
      "default": null,
      "examples": [
        null,
        "c:\\kustodata\\dbs\\"
      ],
      "pattern": "^(.+)$"
    },
    "LogAnalyticsCreate": {
      "$id": "#/properties/LogAnalyticsCreate",
      "type": "boolean",
      "title": "LogAnalyticsCreate",
      "description": "true to create a new log analytics workspace. requires additional options.",
      "default": false,
      "required": [
        "AzureResourceGroup",
        "AzureResourceGroupLocation",
        "AzureSubscriptionId",
        "AzureTenantId",
        "LogAnalyticsName",
        "LogAnalyticsWorkspaceName",
        "LogAnalyticsWorkspaceSku"
      ],
      "examples": [
        false,
        true
      ]
    },
    "LogAnalyticsId": {
      "$id": "#/properties/LogAnalyticsId",
      "type": "string",
      "title": "LoganalyticsId",
      "description": "LogAnalytics Schema Id",
      "required": [
        "LogAnalyticsKey",
        "LogAnalyticsName"
      ],
      "default": null,
      "examples": [
        "0754e191-ccbf-4094-adb9-0653164fb424"
      ],
      "pattern": "^([a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12})$"
    },
    "LogAnalyticsKey": {
      "$id": "#/properties/LogAnalyticsKey",
      "type": "string",
      "title": "LogAnalyticsKey",
      "description": "key from 'advanced settings' for workspace for ingest",
      "default": null,
      "pattern": "^(.+)$"
    },
    "LogAnalyticsName": {
      "$id": "#/properties/LogAnalyticsName",
      "type": "string",
      "title": "LogAnalyticsName",
      "description": "name of ingest for log analytics similar to a table name. name will be prepended with GatherType",
      "default": null,
      "examples": [
        "cluster1_190707"
      ],
      "pattern": "^(.+)$"
    },
    "LogAnalyticsPurge": {
      "$id": "#/properties/LogAnalyticsPurge",
      "type": "string",
      "title": "LogAnalyticsPurge",
      "description": "true to delete data from existing workspace or the purge request id of outstanding purge. see example",
      "default": null,
      "examples": [
        null,
        "true",
        "https://management.azure.com/subscriptions/{{subscriptionId}}/resourceGroups/{{resourceGroup}}/providers/microsoft.operationalinsights/workspaces/{{workspaceId}}/{{logAnalyticsName}}/{{purgeId}}?api-version=2017-01-01-preview"
      ],
      "pattern": "^(true|https://management.azure.com/subscriptions.+)$"
    },
    "LogAnalyticsRecreate": {
      "$id": "#/properties/LogAnalyticsRecreate",
      "type": "boolean",
      "title": "LogAnalyticsRecreate",
      "description": "true to recreate an existing log analytics workspace. requires additional options.",
      "required": [
        "AzureResourceGroup",
        "AzureResourceGroupLocation",
        "AzureSubscriptionId",
        "AzureTenantId",
        "LogAnalyticsName"
      ],
      "default": false,
      "examples": [
        false,
        true
      ]
    },
    "LogAnalyticsWorkspaceName": {
      "$id": "#/properties/LogAnalyticsWorkspaceName",
      "type": "string",
      "title": "LogAnalyticsWorkspaceName",
      "description": "name to use when creating new log analytics workspace. requires additional options.",
      "default": null,
      "examples": [
        "sf-support-logs"
      ],
      "pattern": "^(.+)$"
    },
    "LogAnalyticsWorkspaceSku": {
      "$id": "#/properties/LogAnalyticsWorkspaceSku",
      "type": "string",
      "title": "LogAnalyticsWorkspaceSku",
      "description": "name to use when creating new log analytics workspace. requires additional options. 'free' option only available for log analytics workspaces created before change in policy.",
      "default": "PerGB2018",
      "examples": [
        "PerGB2018",
        "free"
      ],
      "pattern": "^(PerGB2018|free)$"
    },
    "LogDebug": {
      "$id": "#/properties/LogDebug",
      "type": "integer",
      "title": "LogDebug",
      "description": "0-disabled, 1-exception, 2-error, 3-warning, 4-info, 5-debug. use logdebug levels for troubleshooting utility",
      "default": 3,
      "enum": [
        0,
        1,
        2,
        3,
        4,
        5
      ],
      "examples": [
        0,
        1,
        2,
        3,
        4,
        5
      ],
      "pattern": "^([0-5])$"
    },
    "LogFile": {
      "$id": "#/properties/LogFile",
      "type": "string",
      "title": "LogFile",
      "description": "path and file name to log output. can optionally specify .net datetime format specifier inside '<>'. example: collectsfdata-<yyyy-MM-dd-HH-mm-ss>.log",
      "default": "",
      "examples": [
        "c:\\temp\\collectsfdata.log",
        "c:\\temp\\collectsfdata-<yyyy-MM-dd-HH-mm-ss>.log"
      ],
      "pattern": "^(.+)$"
    },
    "NodeFilter": {
      "$id": "#/properties/NodeFilter",
      "type": "string",
      "title": "NodeFilter",
      "description": "string / regex used for filtering of blob storage account uri downloads for node",
      "default": null,
      "examples": [
        null,
        "fabric_",
        "lease",
        "_nt0_0",
        "_nt0_0|_nt0_1",
        "_nt0_(0|1)",
        "_nt0_[0-8]"
      ],
      "pattern": "^(.+)$"
    },
    "NoProgressTimeoutMin": {
      "$id": "#/properties/NoProgressTimeoutMin",
      "type": "integer",
      "title": "NoProgressTimeoutMin",
      "description": "to set no progress timer in minutes. if no progress has been made during timespan, utility will exit. set to 0 to disable.",
      "default": 10,
      "examples": [
        0,
        10
      ]
    },
    "ResourceUri": {
      "$id": "#/properties/ResourceUri",
      "type": "string",
      "title": "ResourceUri",
      "description": "azure service fabric resource uri / resource Id used by microsoft internally for tracking",
      "default": null,
      "examples": [
        null,
        "/subscriptions/{{subscriptionId}}/resourceGroups/{{resourceGroup}}/Microsoft.ServiceFabric/clusters/{{clusterName}}",
        "/subscriptions/{{subscriptionId}}/resourceGroups/{{resourceGroup}}/Microsoft.ServiceFabric/managedClusters/{{clusterName}}"
      ],
      "pattern": "^(/subscriptions/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/resourceGroups/\\w+/providers/Microsoft.ServiceFabric/(clusters|managedClusters)/.+)$"
    },
    "SasKey": {
      "$id": "#/properties/SasKey",
      "type": "string",
      "title": "SasKey",
      "description": "storage shared access signature key required for Azure clusters",
      "default": "",
      "examples": [
        "{{blobServiceSasUrl}}",
        "{{connectionString}}",
        "BlobEndpoint=https://{{storageAccount}}.blob.core.windows.net/;QueueEndpoint=https://{{storageAccount}}.queue.core.windows.net/;FileEndpoint=https://{{storageAccount}}.file.core.windows.net/;TableEndpoint=https://{{storageAccount}}.table.core.windows.net/;SharedAccessSignature={{sasToken}}"
      ],
      "pattern": "^(https://.+(SharedAccessSignature|sig=).+)$"
    },
    "StartTimeStamp": {
      "$id": "#/properties/StartTimeStamp",
      "type": "string",
      "title": "StartTimeStamp",
      "description": "required in specified format",
      "default": "yyyy-MM-dd HH:mm +00:00",
      "examples": [
        "07/06/2019 20:30:00 +00:00",
        "M/d/yy H:mm:ss zzz",
        "M/d/yyyy H:mm:ss zzz",
        "yy/M/d H:mm:ss zzz",
        "yyyy/M/d H:mm:ss zzz",
        "M-d-yy H:mm:ss zzz",
        "M-d-yyyy H:mm:ss zzz",
        "yy-M-d H:mm:ss zzz",
        "yyyy-M-d H:mm:ss zzz"
      ],
      "pattern": "^([0-9]{1,4}(\\/|-)[0-9]{1,2}(\\/|-)[0-9]{1,4} [0-9]{1,2}:[0-9]{1,2}(:[0-9]{1,2}|) (-|\\+)[0-9]{1,2}:[0-9]{1,2})$"
    },
    "Threads": {
      "$id": "#/properties/Threads",
      "type": "integer",
      "title": "Threads",
      "description": "default is cpu core count. can be used to govern resources used by utility",
      "default": 0,
      "examples": [
        null,
        8,
        16
      ]
    },
    "Unique": {
      "$id": "#/properties/Unique",
      "type": "boolean",
      "title": "Unique",
      "description": "default true to check for prior ingest of same uri in same table to prevent duplicate records.",
      "default": true,
      "examples": [
        false,
        true
      ]
    },
    "UriFilter": {
      "$id": "#/properties/UriFilter",
      "type": "string",
      "title": "UriFilter",
      "description": "string / regex used for filtering of blob storage account uri downloads",
      "default": null,
      "examples": [
        null,
        ".trace",
        "fabric_",
        "lease_"
      ],
      "pattern": "^(.+)$"
    },
    "UseMemoryStream": {
      "$id": "#/properties/UseMemoryStream",
      "type": "boolean",
      "title": "UseMemoryStream",
      "description": "true to use memory stream instead of local disk for processing of files. (default)",
      "default": true,
      "examples": [
        false,
        true
      ]
    }
  }
}