-
Notifications
You must be signed in to change notification settings - Fork 1.4k
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
Spinnaker integration #19020
base: master
Are you sure you want to change the base?
Spinnaker integration #19020
Changes from 60 commits
a791717
3299b72
c2b9c2e
8172e51
e610e57
1ce923c
6bd54cb
67d8cb4
cadc4e2
594bc62
3f6f9f0
b4d692b
a51ad8a
fde1c7a
3fb2308
3514af3
ce961cf
fe6fbf1
8f48fd2
bb0b451
8e43cc5
97c6782
e00f21b
772e9b4
1c8d8df
1ec482d
bcc343f
dbc5b02
a9c9dc5
ae72bb4
314da26
d242c4a
89bd852
1714989
c26f092
2f59e7b
670fd21
cfd205b
8a0a4cb
9633796
3cbd705
4076ebe
81ad215
bab0c28
5e3303d
6f2e589
39c2da5
0f0eb34
71de592
35db418
ce9ed5d
aa6b4a0
9b5397c
95f469a
89e31dc
aa5b344
95da0a9
7c13167
0d7a45f
3f1a151
151470f
398b460
2c4a813
091212f
e813ca3
1cd918d
d318b3e
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
@@ -0,0 +1,9 @@ | ||||||||||
# CHANGELOG - Spinnaker | ||||||||||
|
||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Could you add this to the md. We use towncrier to compile our changelogs. One of the validations will fail other wise. |
||||||||||
<!-- towncrier release notes start --> | ||||||||||
|
||||||||||
## 1.0.0 / 2024-11-12 | ||||||||||
|
||||||||||
***Added***: | ||||||||||
|
||||||||||
* Initial Release | ||||||||||
yogesh-s-modak marked this conversation as resolved.
Show resolved
Hide resolved
|
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -0,0 +1,108 @@ | ||||||
# Agent Check: Spinnaker | ||||||
|
||||||
## Overview | ||||||
|
||||||
This check monitors [Spinnaker][1]. | ||||||
|
||||||
Spinnaker is an open-source, multi-cloud continuous delivery (CD) platform originally developed by Netflix. It’s designed to automate and streamline the software release process, enabling faster and more reliable deployments to the cloud. | ||||||
yogesh-s-modak marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
||||||
This integration integrates Spinnaker with Datadog, providing comprehensive monitoring and visibility across all Spinnaker components. It centralizes logs from Clouddriver, Orca, Redis, Rosco, Deck, and Echo, enabling teams to monitor, analyze, and troubleshoot deployment workflows and infrastructure operations efficiently | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
### Benefits of Integration: | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
- **Centralized Monitoring**: Allows customers to view, analyze, and manage all Spinnaker logs in Datadog, improving operational visibility. | ||||||
- **Enhanced Troubleshooting**: Faster root-cause analysis by centralizing logs for different Spinnaker components, helping resolve issues more quickly. | ||||||
- **Performance Optimization**: Detailed metrics for pipelines, caching, image baking, etc., allow fine-tuning of workflows and infrastructure management. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
### Specific Data Monitored: | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
- **Infrastructure Changes**: Logs from Clouddriver, valuable for tracking resource management and API performance. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
- **Pipeline Status and Errors**: Orca logs provide data on pipeline execution and errors, improving deployment reliability. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
- **Cache Performance**: Redis logs monitor caching, helping optimize data retrieval and storage efficiency. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
- **Image Creation and Consistency**: Rosco logs ensure smooth image baking, which supports reliable deployment environments. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
- **User and Notification Activity**: Deck and Echo logs help track UI activity and notifications, ensuring smooth user experience and reliable alerting. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
## Setup | ||||||
|
||||||
### Installation | ||||||
|
||||||
**To install the Spinnaker check on your host:** | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
|
||||||
1. Install the [developer toolkit] | ||||||
(https://docs.datadoghq.com/developers/integrations/python/) | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please use reference-style links. Thank you! |
||||||
on any machine. | ||||||
|
||||||
2. Run `ddev release build spinnaker` to build the package. | ||||||
|
||||||
3. [Download the Datadog Agent][2]. | ||||||
|
||||||
4. Upload the build artifact to any host with an Agent and | ||||||
run | ||||||
`datadog-agent integration install -w | ||||||
path/to/spinnaker/dist/<ARTIFACT_NAME>.whl`. | ||||||
|
||||||
### Configuration | ||||||
|
||||||
#### Prerequisites | ||||||
|
||||||
Have your Datadog [API][10] key on hand. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Just to avoid idioms, which can be confusing for folks who speak English as an additional language. |
||||||
|
||||||
#### Installation | ||||||
To install the Datadog Agent on a host, use the one-line installation, updated with the Datadog API key from your account: | ||||||
|
||||||
`DD_API_KEY=<DATADOG_API_KEY> DD_SITE="datadoghq.com" bash -c "$(curl -L https://install.datadoghq.com/scripts/install_script_agent7.sh)"` | ||||||
|
||||||
- Start the agent using: | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
`sudo systemctl start datadog-agent` | ||||||
|
||||||
- Stop the agent using: | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
`sudo systemctl stop datadog-agent` | ||||||
|
||||||
- Restart the agent using: | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
`sudo systemctl restart datadog-agent` | ||||||
|
||||||
|
||||||
### Validation | ||||||
|
||||||
Check if the agent is running using: | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
- `sudo systemctl status datadog-agent` | ||||||
|
||||||
- `sudo datadog-agent status` | ||||||
|
||||||
## Data Collected | ||||||
|
||||||
### Logs | ||||||
|
||||||
Spinnaker ingests logs from multiple sources. | ||||||
|
||||||
### Metrics | ||||||
|
||||||
Spinnaker does not include any metrics. | ||||||
|
||||||
### Service Checks | ||||||
|
||||||
Spinnaker does not include any service checks. | ||||||
|
||||||
### Events | ||||||
|
||||||
Spinnaker does not include any events. | ||||||
|
||||||
## Troubleshooting | ||||||
|
||||||
Need help? Contact [Datadog support][3]. | ||||||
|
||||||
[1]: **LINK_TO_INTEGRATION_SITE** | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Just flagging this to be updated |
||||||
[2]: https://app.datadoghq.com/account/settings/agent/latest | ||||||
[3]: https://docs.datadoghq.com/agent/kubernetes/integrations/ | ||||||
[4]: https://github.com/DataDog/integrations-extras/blob/master/spinnaker/datadog_checks/spinnaker/data/conf.yaml.example | ||||||
[5]: https://docs.datadoghq.com/agent/guide/agent-commands/#start-stop-and-restart-the-agent | ||||||
[6]: https://docs.datadoghq.com/agent/guide/agent-commands/#agent-status-and-information | ||||||
[7]: https://github.com/DataDog/integrations-extras/blob/master/spinnaker/metadata.csv | ||||||
[8]: https://github.com/DataDog/integrations-extras/blob/master/spinnaker/assets/service_checks.json | ||||||
[9]: https://docs.datadoghq.com/help/ | ||||||
[10]: https://app.datadoghq.com/organization-settings/api-keys?_gl=1*ek9ow0*_gcl_au*MTgxNDQ0MjA4Ni4xNzI1NDQwNjkw*_ga*MTg1OTA0NDgzLjE3MjgyODMwOTQ.*_ga_KN80RDFSQK*MTczMDcxNjc0Ni45LjAuMTczMDcxNjc0Ni4wLjAuMjAyMDM0NjYxNQ..*_fplc*JTJCMGolMkY5OVYyJTJGMEUxaE1EUzUlMkJqcEExcUJJMTRiT2R6ZTg5clpqNmdraHJQJTJCbVFMaFAzcHVXS0ZSdE13OVZWMlA2RUllYTRCVW1od0d0JTJCRUhzUEJXaVFucDFja0NacWk4V1pvamJOejFVUUR2QVVKdlI1WVd2azNuSEY1YzR3JTNEJTNE | ||||||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
name: Spinnaker | ||
files: | ||
- name: spinnaker.yaml | ||
options: | ||
- template: init_config | ||
options: | ||
- template: init_config/default | ||
- template: instances | ||
options: | ||
- template: instances/default |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Where is the parser file?