Port queries and reporting

Introduction

‍

Port’s API comes with a built-in search route that allows you to navigate your Software Catalog with ease. 

Essentially, Port Search is one API to answer all software and infrastructure questions or reporting needs, taking advantage of the breadth and depth of Port’s software catalog and the underlying dependencies of software catalog entities.

Since the Port software catalog contains information about all infrastructure and software elements, such as changes, versions and more, the ability to query it provides valuable information. This provides super detailed information without the need for heavy lifting or effort to unlock and join data from siloed devops tools. Using queries you can:

• Track changes in developer productivity
• Create compliance, auditing, security and migration reporting without the need to write scripts
• Use the software catalog as part of your CI/CD processes, such as verifying that a service isn’t locked before performing a deployment, since the service catalog is always up to date

‍

{{cta_6}}

‍

Queries & Search Usecases

• Upstream or downstream microservices dependencies to other microservice
• Which pull requests were made in the last month
• What is the currently running version of a microservice in the canary deployment in a specific environment? 
• What Kubernetes clusters are affected by the log4j vulnerability? 
• What cloud resources were consumed by each team and what was the expense?
• Which teams have deployed to production in the past 24 hours
• What are the live on-demand environments that were created more than 7 days ago
• What are the services that are running in production and have more than X open bugs

‍

Search in Port is performed by writing simple querying rules which can be combined together to form a more complex and precise query. These same queries can be delivered as reports or made ad hoc.

The following code snippet will get all software components that depend on the recommendation microservice:

def main():
    search_rule = {
        "combinator": "and",
        "rules": [
            {
                "operator": "relatedTo",
                "direction": "downstream",
                "value": "log4j-2-15-0"
            }
        ]
    }
    get_entity_search_result(auth_token, search_rule)

‍

And the result would be a list of all dependent entities (other Microservices, DeploymentConfigs, CIJobRuns, etc.):

[
  {
    "identifier": "payment",
    "title": "payment",
    "blueprint": "service"
  },
  {
    "identifier": "recommendation",
    "title": "recommendation",
    "blueprint": "service"
  },
  {
    "identifier": "product-catalog",
    "title": "product-catalog",
    "blueprint": "service"
  },
  {
    "identifier": "recommendation-production",
    "title": "recommendation-production",
    "blueprint": "runningService"
  },
  {
    "identifier": "e_1wCQlGCYBNqQiboc",
    "title": "recommendations-staging",
    "blueprint": "runningService"
  },
  {
    "identifier": "e_c2EQQ61JoirmZkNZ",
    "title": "recommendations-qa1",
    "blueprint": "runningService"
  }
]

‍