Replace Management Samples #343

TimHess · 2024-10-23T22:19:55Z

Consolidate and update Management samples

~~Blocked by SteeltoeOSS/Steeltoe#1389~~

Resolves #341

part of #319

Planned remaining items before merging:

Resolve gitinfo issues
Address Steeltoe distributed tracing vs direct OpenTelemetry setup

Additional items that could be addressed before merging or considered follow-up items:

~- [ ] ~~List/link actuators exposed by /actuator on home page~~

Greater detail on metrics options, especially in localhost setting

steps/browser_steps.py

Connectors/src/CosmosDb/Program.cs

Management/src/ActuatorApi/README.md

bart-vmware · 2024-10-30T09:46:04Z

Following further on with the API readme steps for running locally, it suddenly stops. I've started all the docker containers and the app, now what to do next? I don't see a port number in appsettings.json. The console output contains:

Now listening on: http://[::]:5140

So I open http://localhost:5140/ in my browser, which returns a 404. Then tried the first entry from the .http file in VS, which fails with:

(1,7): error HTTP0012: Unable to evaluate expression 'HostAddress'.

I'm lost here.

Management/src/ActuatorApi/README.md

bart-vmware · 2024-10-30T10:51:09Z

When running the 3 tasks from readme, no forecasts are shown in browser. Then I realized I shouldn't have run the last step that clears all data. This isn't obvious at first sight. The readme(s) should provide step-by-step instructions to accomplish a scenario, such as here. It would be nice to have a per-actuator short description of what its purpose is (unless obvious), and what to expect when following the steps.

bart-vmware · 2024-10-30T11:12:36Z

Navigating to SpringBootAdmin by opening http://localhost:9090 in the browser (which should be mentioned in the readme) shows Api and Web, but clicking on any of them produces an error. Then I found a commented-out line in appsettings.Development.json instructing to uncomment when using docker instead of podman. That should be mentioned in the readme as well, I wouldn't expect newcomers to dive as deeply as I did. After the change, Api appears offline in SBA and the logs from dotnet run contain multiple warnings, such as:

warn: Steeltoe.Management.Endpoint.ManagementPort.ManagementPortMiddleware[0]
      Access to /actuator/refresh on port 5140 denied because 'Management:Endpoints:Port' is set to 9999.

I get the impression that the various parts of the sample have worked at some point in time, but then things changed, without verification that every scenario still works. Right now, seeing the sample in action requires investigation, and knowledge of Steeltoe internals and the CF/Spring ecosystem, which is a blocker for adoption. The readme(s) should mention the variations in scenarios and what to do (such as changing settings or code) to make it work. I wonder if putting all features together in a single sample resulted in a highly-complex sample that defeats its purpose: showing how easy it is to use Steeltoe. How I handled that in the Discovery sample is by adding additional launch profiles to activate the advanced features, which can easily be ignored by users who don't care.

bart-vmware · 2024-10-30T13:01:21Z

It would be nice if the home page listed all the available actuator endpoints by fetching them from /actuator and rendering clickable links (that open in a new tab).

Management/src/ActuatorApi/Models/WeatherForecast.cs

Management/src/ActuatorApi/Directory.Build.props

Management/src/ActuatorApi/MySqlSeeder.cs

Management/src/ActuatorApi/Program.cs

Management/src/ActuatorApi/BasicAuthExtensions.cs

Management/src/ActuatorApi/Properties/launchSettings.json

Management/src/ActuatorWeb/Program.cs

bart-vmware · 2024-11-01T15:09:36Z

Management/src/ActuatorApi/git.properties

+git.tags=2.1.0-644-g90d0870a
+git.branch=management
+git.build.time=2024-10-11T13:44:28.9255701-05:00
+git.build.user.name=timhe


Should this be anonymized?

Yeah, that's a better idea... what is here now is just what was generated and I think I had to override the .gitignore for it to be included at all. There are still some oddities with whether or not this file can be generated or included in publishing that I want to better understand... like how can we get the feature to work with cf push when the git info isn't included for it to be generated (this isn't working: <Content Include="git.properties" />)

Integration with msbuild is described at https://docs.steeltoe.io/api/v3/management/info.html:

Thanks, I already had that piece included, but the msbuild integration itself does not work when .git is not there (such as when source for an app that lives in a monorepo is pushed)

Just a wild guess: would it work to include the file from an MSBuild target that runs after one of the git targets, such as here?

File contents are anonymized and I found a very simple solution for the problem:

<ItemGroup> <None Update="git.properties"> <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory> </None> </ItemGroup>

When I run dotnet build or dotnet publish ..., it copies the git.properties file containing some-user into the output directory. I would have expected that the MSBuild task runs and produces a git.properties file with actual data from git, like the last commit date, uid, etc. Am I missing something?

Yeah, there's a condition on the build target so it doesn't fail if the git info isn't available (eg when pushing just the app directory to CF)

<Target Name="_GitProperties" AfterTargets="CoreCompile" Condition="!Exists('git.properties')">

If you want to see what gets generated, delete the file before build/publish

Can't we make it work the other way around, ie generate the file, unless that's not possible like during cf push?

also address feedback various

bart-vmware

Gone over most of the files again, but haven't run anything yet.

There are quite some TODOs in the readme, can you move them to separate issues if they won't be addressed in this PR?

Management/src/ActuatorApi/WeatherEndpoints.cs

Management/src/ActuatorApi/AdminTasks/ForecastTask.cs

Management/src/ActuatorApi/BasicAuthExtensions.cs

Management/src/ActuatorApi/Data/WeatherContext.cs

Management/src/ActuatorWeb/Pages/Error.cshtml

Management/src/ActuatorWeb/Pages/Shared/_Layout.cshtml

Management/src/ActuatorWeb/Properties/launchSettings.json

bart-vmware · 2024-11-05T11:32:50Z

Management/src/ActuatorWeb/Properties/launchSettings.json

@@ -0,0 +1,22 @@
+{


Should we put launchBrowser and launchUrl in the profiles, so the user can F5 to run the project (here and/or in api project)?

In ActuatorWeb, launchUrl should just be an empty string. In ActuatorApi, launchUrl is missing in the http profile.

bart-vmware · 2024-11-05T11:38:37Z

Management/src/ActuatorWeb/README.md

+
+<!-- TODO: more testing, more specific instructions -->
+
+If you wish to collect and view applications metrics in [App Metrics for VMware Tanzu](https://docs.vmware.com/en/App-Metrics-for-VMware-Tanzu/index.html), you must first configure [Metrics Registrar](https://docs.pivotal.io/platform/application-service/2-9/metric-registrar/index.html) in the TAS for VMs tile. There is no separate product tile (unlike the metrics forwarder). Once thats complete custom metrics will be collected and automatically exported to the Metrics Forwarder service.  


Suggested change

If you wish to collect and view applications metrics in [App Metrics for VMware Tanzu](https://docs.vmware.com/en/App-Metrics-for-VMware-Tanzu/index.html), you must first configure [Metrics Registrar](https://docs.pivotal.io/platform/application-service/2-9/metric-registrar/index.html) in the TAS for VMs tile. There is no separate product tile (unlike the metrics forwarder). Once thats complete custom metrics will be collected and automatically exported to the Metrics Forwarder service.

If you wish to collect and view applications metrics in [App Metrics for VMware Tanzu](https://docs.vmware.com/en/App-Metrics-for-VMware-Tanzu/index.html), you must first configure [Metrics Registrar](https://docs.pivotal.io/platform/application-service/2-9/metric-registrar/index.html) in the TAS for VMs tile. There is no separate product tile (unlike the metrics forwarder). Once that's complete, custom metrics will be collected and automatically exported to the Metrics Forwarder service.

TimHess · 2024-11-05T19:25:57Z

It would be nice if the home page listed all the available actuator endpoints by fetching them from /actuator and rendering clickable links (that open in a new tab).

This sounds nice and I was initially in favor of it... But the actuators are being secured with basic auth, so I don't think we can make normal clickable links. We could do some fancy JS work and build a super basic client for the actuators, but maybe we're better off relying on the .http files and/or SBA to do the heavy lifting rather than adding more.

Co-authored-by: Bart Koelman <[email protected]>

#204 (comment)

bart-vmware · 2024-11-15T08:35:08Z

Management/src/ActuatorApi/git.properties

+git.tags=2.1.0-644-g90d0870a
+git.branch=management
+git.build.time=2024-10-11T13:44:28.9255701-05:00
+git.build.user.name=timhe


When I run dotnet build or dotnet publish ..., it copies the git.properties file containing some-user into the output directory. I would have expected that the MSBuild task runs and produces a git.properties file with actual data from git, like the last commit date, uid, etc. Am I missing something?

bart-vmware · 2024-11-15T08:40:19Z

Management/src/ActuatorWeb/OpenTelemetryExtensions.cs

+    {
+        // Add OpenTelemetry
+        services.AddOpenTelemetry().WithTracing(tracerProviderBuilder =>


Suggested change

{

// Add OpenTelemetry

services.AddOpenTelemetry().WithTracing(tracerProviderBuilder =>

{

services.AddOpenTelemetry().WithTracing(tracerProviderBuilder =>

bart-vmware · 2024-11-15T08:47:59Z

Management/src/README.md


 ## Building & Running

 See the Readme for instructions on building and running each app.

 ---

-### See the Official [Steeltoe Management Documentation](https://steeltoe.io/docs/steeltoe-management) for a more in-depth walkthrough of the samples and more detailed information
+### See the Official [Steeltoe Management Documentation](https://docs.steeltoe.io/api/v3/management/) for a more in-depth walkthrough of the samples and more detailed information


The markdown linter sounds right to me. I think this shouldn't be a header in the first place. It probably is today only to increase the font size. I'd be fine to remove the ### and make it a sentence. We already have separator (---) that makes it look like a footer.

README.md

bart-vmware · 2024-11-15T08:55:07Z

CommonTasks.md


-```script
-docker run --rm -ti -p 1433:1433 --name steeltoe-sqlserver -e 'ACCEPT_EULA=Y' -e 'SA_PASSWORD=St33ltoeR0cks!' mcr.microsoft.com/mssql/server
+> Note that this image has the management plugin enabled and no credentials set:


Now that it's a note, we don't need to repeat that. And it should end with a dot, not a colon. Suggestion:

This image has the management plugin enabled and no credentials set.

bart-vmware · 2024-11-15T09:03:56Z

Management/src/ActuatorWeb/Properties/launchSettings.json

@@ -0,0 +1,22 @@
+{


In ActuatorWeb, launchUrl should just be an empty string. In ActuatorApi, launchUrl is missing in the http profile.

TimHess added 3 commits October 16, 2024 15:20

Replace Management samples with two new apps built from .NET 8 templates

238a333

tweaks for CI test

8fd1a94

refine contents, comments, readmes, .http files

8d18cd0

TimHess added Component/Management Issues related to Steeltoe Management (actuators) ReleaseLine/4.x labels Oct 23, 2024

TimHess self-assigned this Oct 23, 2024

TimHess mentioned this pull request Oct 23, 2024

Bump certifi from 2023.7.22 to 2024.7.4 #336

Closed

TimHess added 4 commits October 23, 2024 17:43

update dotSettings files, Actuator API changes

6cb8eaf

include cf config with connector samples so actuator integration works

b3ff1a2

code cleanup

1cc3648

comment formatting

e60b6ae

TimHess marked this pull request as ready for review October 28, 2024 21:31

TimHess commented Oct 28, 2024

View reviewed changes

steps/browser_steps.py Show resolved Hide resolved

steps/browser_steps.py Show resolved Hide resolved

TimHess requested a review from bart-vmware October 29, 2024 14:12

This comment was marked as resolved.

Sign in to view

bart-vmware requested changes Oct 30, 2024

View reviewed changes

Connectors/src/CosmosDb/Program.cs Outdated Show resolved Hide resolved

Management/src/ActuatorApi/README.md Outdated Show resolved Hide resolved

bart-vmware reviewed Oct 30, 2024

View reviewed changes

Management/src/ActuatorApi/README.md Outdated Show resolved Hide resolved

This comment was marked as resolved.

Sign in to view

bart-vmware requested changes Oct 30, 2024

View reviewed changes

Management/src/ActuatorApi/README.md Outdated Show resolved Hide resolved

bart-vmware requested changes Oct 30, 2024

View reviewed changes

bart-vmware reviewed Nov 1, 2024

View reviewed changes

review feedback

9cedbd0

This comment was marked as resolved.

Sign in to view

enhance common tasks, allow changing forecast request from web

bb9ceb3

also address feedback various

TimHess requested a review from bart-vmware November 4, 2024 23:01

bart-vmware reviewed Nov 5, 2024

View reviewed changes

TimHess and others added 2 commits November 5, 2024 15:30

Apply suggestions from code review

3842249

Co-authored-by: Bart Koelman <[email protected]>

review feedback: names, formatting, error handling

5dc2e45

TimHess requested a review from bart-vmware November 6, 2024 14:24

TimHess added 2 commits November 6, 2024 14:35

cleanup

8969b48

Add custom actuator

4040b60

#204 (comment)

bart-vmware reviewed Nov 15, 2024

View reviewed changes

TimHess and others added 2 commits November 15, 2024 10:13

add prometheus + grafana, feedback and cleanup

d64ec44

Inject HttpClient into model

0dc48ca

TimHess mentioned this pull request Nov 15, 2024

Consider injecting HttpClient instead of IHttpClientFactory #345

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Replace Management Samples #343

Replace Management Samples #343

TimHess commented Oct 23, 2024 •

edited

Loading

This comment was marked as resolved.

This comment was marked as resolved.

bart-vmware commented Oct 30, 2024

This comment was marked as resolved.

This comment was marked as resolved.

bart-vmware commented Oct 30, 2024 •

edited

Loading

bart-vmware commented Oct 30, 2024 •

edited

Loading

bart-vmware commented Oct 30, 2024

bart-vmware Nov 1, 2024

TimHess Nov 1, 2024

bart-vmware Nov 1, 2024

TimHess Nov 1, 2024

bart-vmware Nov 4, 2024

TimHess Nov 5, 2024

bart-vmware Nov 15, 2024

TimHess Nov 15, 2024

bart-vmware Nov 15, 2024

This comment was marked as resolved.

bart-vmware left a comment

bart-vmware Nov 5, 2024

bart-vmware Nov 15, 2024

bart-vmware Nov 5, 2024

TimHess commented Nov 5, 2024

bart-vmware Nov 15, 2024

bart-vmware Nov 15, 2024

bart-vmware Nov 15, 2024

bart-vmware Nov 15, 2024

bart-vmware Nov 15, 2024


		<!-- TODO: more testing, more specific instructions -->

		If you wish to collect and view applications metrics in [App Metrics for VMware Tanzu](https://docs.vmware.com/en/App-Metrics-for-VMware-Tanzu/index.html), you must first configure [Metrics Registrar](https://docs.pivotal.io/platform/application-service/2-9/metric-registrar/index.html) in the TAS for VMs tile. There is no separate product tile (unlike the metrics forwarder). Once thats complete custom metrics will be collected and automatically exported to the Metrics Forwarder service.

Replace Management Samples #343

Are you sure you want to change the base?

Replace Management Samples #343

Conversation

TimHess commented Oct 23, 2024 • edited Loading

This comment was marked as resolved.

This comment was marked as resolved.

bart-vmware commented Oct 30, 2024

This comment was marked as resolved.

This comment was marked as resolved.

bart-vmware commented Oct 30, 2024 • edited Loading

bart-vmware commented Oct 30, 2024 • edited Loading

bart-vmware commented Oct 30, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

This comment was marked as resolved.

bart-vmware left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TimHess commented Nov 5, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TimHess commented Oct 23, 2024 •

edited

Loading

bart-vmware commented Oct 30, 2024 •

edited

Loading

bart-vmware commented Oct 30, 2024 •

edited

Loading