Skip to main content

➕ 计算属性

计算属性允许您直接或通过使用关系和镜像属性使用蓝图上定义的现有属性，以便通过使用jq 处理器为 JSON 创建新属性。

  • 过滤/选择/切片/合并现有属性中的数据；
  • 创建数学公式或修改。例如，通过指定页面大小和所需页面数计算所需磁盘存储空间。
  • 合并复杂属性，包括深度合并和覆盖。

💡 常用计算 Usage​

计算属性可以更方便地定义基于其他属性值的属性，并增加了转换数据等功能:

  • 根据模板构建自定义 URL，例如
    • https://slack.com/ + {my_parameter}；
    • https://datadog.com/ + {my_parameter}；
    • https://launchdarkly.com/ + {my_parameter}；
  • 合并服务配置模板，创建真正的服务配置；
  • 计算代码 Owners 的数量；
  • 等等。

在live demo 这个示例中，我们可以看到 "Slack Notifications "计算属性。

定义​

calculationProperties "键是实体 JSON 中的顶级键(类似于 "identifier"、"title"、"properties "等)。

您可以使用 .properties 作为计算的一部分访问属性

{
  "calculationProperties": {
    "myCalculationProp": {
      "title": "My calculation property",
      "type": "string",
      "calculation": ".properties.myStringProp + .properties.myStringProp"
    }
  }
}

Check out Port's API reference to learn more.

支持的类型​

计算属性支持以下输出类型: "字符串"、"数字"、"对象"、"数组 "和 "布尔"。 例如:

{
  "calculationProperties": {
    "myCalculationProp": {
      "title": "My calculation property",
      "type": "my_output_type",
      "calculation": ".properties.myStringProp + .properties.myStringProp"
    }
  }
}

在计算属性中被用于`元属性​

可以将meta properties 作为计算属性的模板值。

例如，如果要将模板 URL(如 https://datadog.com)与 identifier 元属性连接起来:

给定以下 "通知服务 "实体:

{
  "identifier": "notification-service",
   "title": "Notification Service",
  "properties": {
   ...
  },
}

蓝图的计算属性定义如下:

{
  "calculationProperties": {
    "monitorUrl": {
      "title": "Monitor url",
      "type": "string",
      "format": "url",
      "calculation": "'https://datadog.com/' + .identifier"
    }
  }
}

属性 monitorUrl 的值将是 https://datadog.com/notification-service

在计算属性中被用于`镜像属性​

可以将mirror properties 作为计算属性的模板值。

例如，如果一个实体有一个名为 "owningSquad "的镜像属性:

"mirrorProperties": {
    "owningSquad": {
        "path": "microservice-to-squad.$title"
    }
}

与小队松弛频道链接的计算属性可以是

"owning_squad_slack": {
    "title": "Owning Squad Channel",
    "calculation": "'https://slack.com/' + .properties.owningSquad",
}

着色计算属性​

通过在计算属性对象中添加一个值为 true 的 colorized 键，可以根据计算属性的值为其着色。 您还可以添加一个 colors 键来指定不同值的颜色，否则，颜色将自动为您选择。

例如，如果要为名为 "status-calculation "的计算属性着色，使其具有 "OK"、"WARNING "和 "CRITICAL "三个 Values 值:

"properties":{
    "status":{
        "type": "string"
    },
},
"calculationProperties": {
    "status-calculation": {
        "title": "Status",
        "type": "string",
        "calculation": ".properties.status",
        "colorized": true,
        "colors": {
            "OK": "green",
            "WARNING": "yellow",
            "CRITICAL": "red"
        }
    }
}
包含特殊字符的参数 参数包含特殊字符(例如: -)或以数字开头(例如: @/#/$/1/2/3)时，应用单引号括起来。
"properties":{
    "prop-with-special-char":{
        "type": "string"
    },
},
"calculationProperties": {
    "myCalculatedProp": {
        "title": "My Calculated Property",
        "type": "string",
        "calculation": ".properties.'prop-with-special-char'",
    }
}

示例​

请参阅计算属性examples 页面。