Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: [Feb Release] Scorecards PP [Do Not Merge] #19937

Draft
wants to merge 11 commits into
base: develop
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
---
title: "Catalogs"
tag:
- "Service Architecture Intelligence"
- "Catalogs"
- "Software Catalog"
metaDescription: "Catalogs offer a single pane view to enhance the observability and management of software systems in your organization. The unified view of system entities facilitates well-informed decision-making, streamlined operations, and improved collaboration across teams."
freshnessValidatedDate: never
---


<Callout title="Preview">
We're still working on this feature, but we'd love for you to try it out!
This feature is currently provided as part of a preview pursuant to our [pre-release policies](https://docs.newrelic.com/docs/licenses/license-information/referenced-policies/new-relic-pre-release-policy/).
</Callout>



New Relic Catalogs provides a single-pane view that enhances the observability and management of systems across your organization. By offering a unified perspective on entities, it empowers teams to make well-informed decisions, streamline operations, and collaborate more effectively.

With Catalogs, you can quickly identify and focus on the most relevant information, ensuring easy access to what matters most. It serves as the single source of truth, enabling users to discover, manage, and optimize their systems with confidence.

By consolidating data from multiple sources—including including <DNT>[Teams](/docs/service-architecture-intelligence/teams/teams)</DNT>, <DNT>[Scorecards](/docs/service-architecture-intelligence/catalogs/scorecards/scorecards)</DNT>, <DNT>[maps](/docs/service-architecture-intelligence/maps/advance-maps/)</DNT>, and <DNT>[repository](/docs/codestream/observability/repo-association/)</DNT> into a single interface. Catalogs replaces the <DNT>All Entities</DNT> view, offering a more structured and insightful experience. It provides a comprehensive overview of high-value entities, enriched with detailed metadata and actionable insights, helping teams stay aligned and efficient.



## Key features [#features]

- **Unified view**: Catalog is integrated with various sources such as<DNT>[Teams](/docs/service-architecture-intelligence/teams/teams)</DNT>, <DNT>[Scorecards](/docs/service-architecture-intelligence/catalogs/scorecards/scorecards)</DNT>, <DNT>[maps](/docs/service-architecture-intelligence/maps/advance-maps/)</DNT>, and <DNT>[repository](/docs/codestream/observability/repo-association/)</DNT> into a single cohesive interface. This displays high-value entity types with detailed metadata including golden metrics and insights to provide a deeper understanding of system status.

- **Personalized experience**: <DNT>Software Catalog</DNT> allows users to customize their view to focus on the most relevant content. This helps users to streamline workflows and enhance productivity.

- **Seamless integration**: <DNT>Software Catalog</DNT> connects users with other New Relic capabilities to allow them to explore data in depth and gain a thorough understanding of entities.

- **Ownership**: <DNT>Catalog</DNT> displays the entity ownership information in the <DNT>Teams</DNT> column. Hover over the <DNT>Teams</DNT> link for more information. Click the <DNT>Teams</DNT> link to visit the <DNT>Teams Hub</DNT> page. For more information, refer <DNT>[Teams](/docs/service-architecture-intelligence/teams/teams)</DNT>.

- **<DNT>Score</DNT>**: <DNT>Software Catalog</DNT> is integrated with Scorecards to show how your entities are performing against company defined best practices. For more information, refer <DNT>[Scorecards.](/docs/service-architecture-intelligence/catalogs/scorecards/scorecards)</DNT>





## Getting started [#getting-started]

### Enable the Catalogs


**To integrate the catalogs inventory:**

1. Log in to your New Relic platform.
2. Go to the **left navigation pane > All Entities**.
3. Click the **Try It Now** button.
4. Follow the on-screen instructions and accept the terms & conditions to complete the on-boarding.
After you complete the boarding, the Catalog page displays, replacing the <DNT>All Entities</DNT> page.


{/* <img
title="Catalog"
alt="Catalog"
src={CatalogHome}
/> */}

<Callout variant="tip" title="Tip">
To go back to <DNT>All Entities</DNT> page, refer [Back to All Entities](#back-entities).
</Callout>



### Personalize the view [#personalized-view]

By default, the <DNT>Catalog</DNT> page displays the entity from Teams associated with your user account. However, you can further customize the <DNT>Catalog</DNT> view to add or remove filters and columns based on your preferences. This allows you to focus on the most relevant content and streamline your workflows.

{/* <img
title="Filters in Catalog"
alt="Filters in Catalog"
src={CatalogFilters}
/> */}

<table>
<thead>
<tr>
<th>Action</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>To add filters</td>
<td>Click the plus icon <DNT>(+)</DNT> in the top pane and select the required filter from the list. You can add multiple filters to refine your search.</td>
</tr>
<tr>
<td>To show or hide columns</td>
<td>Click the gear icon on the right pane and select or deselect the required columns to show or hide.</td>
</tr>

</tbody>
</table>

#### Save and access the personalized view

You can save your customized view for quick access.

<table>
<thead>
<tr>
<th>Action</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>To save a view</td>
<td>On the top-left, click <DNT>Save view</DNT> next to the Catalog capability title.</td>
</tr>
<tr>
<td>To access a saved view</td>
<td>Click the Catalog capability title to display a list of available <DNT>Save view</DNT>.</td>
</tr>

</tbody>
</table>


### Back to All Entities [#back-entities]

The new Catalog view replaces the <DNT>All Entities</DNT> capability from the navigation. If you need to find entity types other than the supported entities in the <DNT>Catalog</DNT>, use the <DNT>Quick Find `(cmd + K or ctrl+K)`</DNT> global search, or find them in their corresponding capabilities, such as Infrastructure, Synthetics, Workloads, Service Levels, and more.

<Callout variant="tip" title="Tip">

Any link, permalink, or saved view referring to <DNT>All Entities</DNT> will continue to work as expected, regardless if you are in the new <DNT>Catalog</DNT> experience or you decided to switch back to <DNT>All Entities</DNT>.

</Callout>


To go back to the <DNT>All Entities</DNT> page:

1. Log in to your New Relic platform.
2. Go to the **left navigation pane > Catalog**.
2. Click the <DNT>**Switch back to all entities**</DNT> button. This enables the New Relic <DNT>All Entities</DNT> experience.

<Callout variant="tip" title="Tip">

To go back to the <DNT>Catalog</DNT> view, click the <DNT>**Try it out**</DNT> button in the header, next to the <DNT>All Entities</DNT> capability name.

</Callout>

{/* <img
title="Catalog"
alt="Catalog"
src={CatalogHome}
/> */}
Original file line number Diff line number Diff line change
@@ -0,0 +1,136 @@
---
title: "Repository catalogs"
tag:
- "Service Architecture Intelligence"
- "Repository"
- "Catalog"
metaDescription: The Repository Catalog is a tool designed to centralize and streamline the management of repositories within an organization.
freshnessValidatedDate: never
---


<Callout title="Preview">
We're still working on this feature, but we'd love for you to try it out!
This feature is currently provided as part of a preview pursuant to our [pre-release policies](https://docs.newrelic.com/docs/licenses/license-information/referenced-policies/new-relic-pre-release-policy/).
</Callout>


The <DNT>Repository Catalog</DNT> is a tool designed to centralize and streamline the management of repositories within an organization. By providing a unified view of all repositories, it enhances cross-team collaboration and simplifies the discovery, access, and management of code repositories.

The <DNT>Repository Catalog</DNT> is designed to break silos between teams and increase cross-team collaboration. It enables developers, Site Reliability Engineers (SREs), and other stakeholders to efficiently identify existing repositories, understand their purpose, and determine ownership or status. This centralized approach leads to improved collaboration, accountability, and productivity across the organization.


## Key features [#features]

- **Centralized Repository Discovery:** Quickly identify repositories relevant to services, projects, or <DNT>[Teams](https://docs-preview.newrelic.com/docs/teams/teams)</DNT>, <DNT>[Scorecards](https://docs-preview.newrelic.com/docs/scorecards)</DNT>, minimizing the time spent searching or consulting with colleagues.

- **Service and Repository Navigation:** Seamlessly navigate from applications or services to their defining repositories and vice versa, aiding in understanding code dependencies and infrastructure.

- **Ownership and Accountability:** Easily identify repository owners, supporting direct queries and enhancing accountability within teams.

- **Repository Insights:** Access detailed metrics on repository activity, such as commits, open pull requests, and deployment history, to identify neglected projects and optimize resource allocation.

- **Management and Operations:** Perform bulk operations, such as assigning tags or teams, to efficiently manage repositories and maintain organizational standards.


### Access the Software Catalogs


**To access the Software Catalogs inventory:**

1. Log in to your New Relic platform.
2. Go to the **left navigation pane > Catalogs > Repository Catalogs**.

{/*
<img
title="Repository catalogs"
alt="RepositoryCatalog"
src="static/images/catalogs.webp"
/> */}



The <DNT>Repositories Catalog</DNT> displays all the linked repository and related information:

<table>
<thead>
<tr>
<th>UI</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><DNT>Name</DNT></td>
<td>The name of the repository. Click to open the repository details pane on the right-side. This details pane contains information such as repository overview, entities repository linked with, tags, and more.</td>
</tr>
<tr>
<td><DNT>Description</DNT></td>
<td>The description of the repository.</td>
</tr>
<tr>
<td><DNT>Origin/Source</DNT></td>
<td>Display the information where this repository is hosted.</td>
</tr>
<tr>
<td><DNT>Organization</DNT></td>
<td>GitHub organization from where the repos have been imported.</td>
</tr>
<tr>
<td><DNT>Team</DNT></td>
<td>The team responsible for the entity. Click on the team's name to go to the corresponding team's hub page to view more information of team's managing the entity. Hover the mouse to the <DNT>Team</DNT> link to view additional details in the pop-up dialog box. If a Team is not assigned to an entity, click the <DNT>Assign Team</DNT> button and select the responsible team from the displayed list. For more information, refer [Teams](https://docs-preview.newrelic.com/docs/teams/teams). </td>
</tr>
<tr>
<td><DNT>Last Deploy</DNT></td>
<td>The date and time of the last deployment. Click the link to view details of the change and its impact. For more information, refer [Change Tracking.](https://docs.newrelic.com/docs/change-tracking/change-tracking-introduction/) </td>
</tr>
<tr>
<td><DNT>Entities</DNT></td>
<td>The number of entities linked with the repository.</td>
</tr>
<tr>
<td><DNT>URL</DNT></td>
<td>The URL to access the repository.</td>
</tr>
<tr>
<td><DNT>Clone links</DNT></td>
<td>Provides the clone links such as HTTPS, SSH, and GitHub CLI links for the repository.</td>
</tr>
<tr>
<td><DNT>Last Deploy</DNT></td>
<td>The date and time of the last deployment. Click the link to view details of the change and its impact. For more information, refer [Change Tracking.](/docs/change-tracking/change-tracking-introduction/)</td>
</tr>
<tr>
<td><DNT>Open PRs</DNT></td>
<td>Displays the number of open pull requests in the repository. Hover the mouse to the link to view additional details in the pop-up dialog box.</td>
</tr>
<tr>
<td><DNT>Commit in Open PRs</DNT></td>
<td>Displays the number of commits. Hover the mouse to the link to view additional details in the pop-up dialog box. </td>
</tr>
<tr>
<td><DNT>Creation Date</DNT></td>
<td>Displays the date when the repository is created.</td>
</tr>
<tr>
<td><DNT>Last Update</DNT></td>
<td>Displays the date when the repository is updated.</td>
</tr>
<tr>
<td><DNT>Primary Language</DNT></td>
<td>Displays the most used language in the repository.</td>
</tr>
</tbody>
</table>


## ## Add new data [#add-new-data]

To add additional data to your Repository Catalogs click the **+ Add Data** button at the top right. Follow the on screen instructions to add data to your repositories.

NEEDED NEW IMAGES


### Limitations [#limitations]

- No support for sorting data in the <DNT>Repository Catalog</DNT> page.
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
---
title: Software Catalog
metaDescription: Learn how to use the Software Catalog to view and manage your software entities in New Relic.
tags:
- catalog
- software catalog
- service architecture intelligence
- software entities
freshnessValidatedDate: never
---

<Callout title="Preview">
We're still working on this feature, but we'd love for you to try it out!
This feature is currently provided as part of a preview pursuant to our [pre-release policies](https://docs.newrelic.com/docs/licenses/license-information/referenced-policies/new-relic-pre-release-policy/).
</Callout>


Software Catalog offers a single pane view to enhance the observability and management of entities in your organization. The unified view of Services - APM, Services - OpenTelemetry, Browser, and Mobile entities facilitates well-informed decision-making, streamlined operations, and improved collaboration across teams.


### Supported entities [#supported-entities]

The current New Relic Catalog experience supports the following entities:

* `Services - APM`
* `Services - OpenTelemetry`
* `Browser`
* `Mobile`

### Access the Software Catalogs


**To access the Software Catalogs inventory:**

1. Log in to your New Relic platform.
2. Go to the **left navigation pane > Catalogs > Software Catalogs**.


{/* <img
title="Catalog"
alt="Catalog"
src={CatalogHome}
/> */}


The <DNT>Catalog</DNT> page has multiple columns to displays various information for an entity. The following table provides information about each column available in the <DNT>Catalog</DNT> page UI:

<table>
<thead>
<tr>
<th>UI</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><DNT>Name</DNT></td>
<td>The name of the catalog entity. Click to open the <DNT>Entity Overview</DNT> page. Hover the mouse to the entity name to view additional details in pop-up dialog box. You can also click the links in the pop-up dialog box or entity name to open the <DNT>Entity Overview</DNT> page.</td>
</tr>
<tr>
<td><DNT>Type</DNT></td>
<td>The type of the entity. Currently, we support `Services - APM`, `Services - OpenTelemetry`, `Browser`, and `Mobile` entities.</td>
</tr>
<tr>
<td><DNT>Language</DNT></td>
<td>Display the programming language associated with the entity. This is visible when there is a language tag associated with an entity.</td>
</tr>
<tr>
<td><DNT>Score</DNT></td>
<td>Display the % of scorecard rules for the entity. This value helps you to understand how entities are performing against company best practices defined within the Scorecards capability. Hover the mouse to the score to view additional details in the pop-up dialog box. For more information, refer [Scorecards.](https://docs-preview.newrelic.com/docs/scorecards)</td>
</tr>
<tr>
<td><DNT>Team</DNT></td>
<td>The team responsible for the entity. Click on the team's name to go to the corresponding team's hub page to view more information of team's managing the entity. Hover the mouse to the <DNT>Team</DNT> link to view additional details in the pop-up dialog box. If a Team is not assigned to an entity, click the <DNT>Assign Team</DNT> button and select the responsible team from the displayed list. For more information, refer [Teams](https://docs-preview.newrelic.com/docs/teams/teams). </td>
</tr>
<tr>
<td><DNT>Issues</DNT></td>
<td>The number of active issues created in the <DNT>past 24 hours</DNT>. Hover the mouse to the cell to view a brief overview on those entities' issues. Click the number to view the details. Hover the mouse to the <DNT>Issues</DNT> link to view additional details in the pop-up dialog box. You can also click the links in the pop-up dialog box to open the Alerts. For more information, refer [Alerts](https://docs.newrelic.com/docs/alerts/overview/) and [Issues](https://docs.newrelic.com/docs/alerts/incident-management/Issues-and-Incident-management-and-response/).</td>
</tr>
<tr>
<td><DNT>Last Deploy</DNT></td>
<td>The date and time of the last deployment. Click the link to view details of the change and its impact. For more information, refer [Change Tracking.](https://docs.newrelic.com/docs/change-tracking/change-tracking-introduction/) </td>
</tr>
<tr>
<td><DNT>Repositories</DNT></td>
<td>The repositories associated with the entity. Click on the repository link to open the repository. Hover the mouse to the <DNT>Repositories</DNT> link to open the repositories. For more information, refer [Connect the repository to services](https://docs.newrelic.com/docs/codestream/observability/repo-association/).</td>
</tr>
<tr>
<td><DNT>Golden metrics</DNT></td>
<td>Displays the metrics related to the different entity types. These metrics can help you to better assess how these catalog entries are performing. This includes: Response time, Throughput, Error Rate, and others. </td>
</tr>

</tbody>
</table>

## Add new data [#add-new-data]

To add additional data to your software catalogs click the **+ Add Data** button at the top right. Follow the on screen instructions to add data to your software catalogs.

NEEDED NEW IMAGES


## Limitations [#limitations]

* No support for sorting data in the <DNT>Software Catalog</DNT> page.
Loading
Loading