You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description
Improve Readme - metrics section
<!-- Issue number (e.g. #1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Closes#38891
<!--Describe what testing was performed and which tests were added.-->
#### Testing
<!--Describe the documentation added.-->
#### Documentation
<!--Please delete paragraphs that you did not use before submitting.-->
---------
Co-authored-by: Antoine Toulme <[email protected]>
Co-authored-by: Curtis Robert <[email protected]>
Co-authored-by: Adriel Perkins <[email protected]>
`github_org` (**required**): Specify the GitHub organization or username to scrape.
93
+
94
+
`endpoint` (optional): Set this only when using a self-managed GitHub instance (e.g., `https://selfmanagedenterpriseserver.com` -- SHOULD NOT include `api` subdomain or `/graphql` context path).
95
+
96
+
`search_query` (optional): A filter to narrow down repositories. Defaults to `org:<github_org>` (or `user:<username>`). For example, use `repo:<org>/<repo>` to target a specific repository. Any valid GitHub search syntax is allowed.
97
+
98
+
`metrics` (optional): Enable or disable metrics scraping. See the [metrics documentation](./documentation.md) for details.
99
+
90
100
### Scraping
91
101
92
102
> Important:
@@ -100,6 +110,17 @@ see the [Scraping README][ghsread].
To create a GitHub Personal Access Token (PAT), please refer to the official [documentation](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens).
117
+
118
+
**Organization or Personal Access:**
119
+
When generating the PAT, select the appropriate `Resource owner` — either your personal account or the organization and choose the correct `Repository access` type. For fine-grained tokens, explicitly configure the necessary `Repository permissions` or `Organization permissions`.
120
+
121
+
**Note**:
122
+
The PAT must have read access to the target repositories. If the PAT doesn't have permission to access repositories in the target organization, only the repository count metric will be available. Detailed repository metrics cannot be fetched.
123
+
103
124
## Traces - Getting Started
104
125
105
126
Workflow tracing support is accomplished through the processing of GitHub
0 commit comments