Getting a list of active grains in Orleans for monitoring #1772

Dewaldf · 2016-05-17T14:09:47Z

Gives the developer to get a list of active grains from Orleans, for monitoring etc. See #1751.

Since the list that could be returned could be a very big list, I added an attribute that the developer will need to decorate his class with, if he wants that type of grain to be returned. This gives developers the opportunity to specify only certain grains.

…ics(SiloAddress[] hostsIds), GetDetailedGrainStatistics()) , that can be used to get more details about all the active grains.

…nt to be returned when GetDetailedGrainStatistics is called.

… in having the entire type object

dnfclas · 2016-05-17T14:09:52Z

Hi @Dewaldf, I'm your friendly neighborhood .NET Foundation Pull Request Bot (You can call me DNFBOT). Thanks for your contribution!

In order for us to evaluate and accept your PR, we ask that you sign a contribution license agreement. It's all electronic and will take just minutes. I promise there's no faxing. https://cla2.dotnetfoundation.org.

TTYL, DNFBOT;

dnfclas · 2016-05-17T14:18:17Z

@Dewaldf, Thanks for signing the contribution license agreement so quickly! Actual humans will now validate the agreement and then evaluate the PR.

Thanks, DNFBOT;

…t the attribute is not checked for every grain. Fixed code formatting.

sergeybykov · 2016-05-17T22:52:15Z

src/OrleansRuntime/Catalog/Catalog.cs

+                        isManagementFilterableGrain =
+                            data.GrainInstanceType.IsDefined(typeof (ManagementFilterableGrain), false);
+                        //we need to add the new type to the dictionary now,so that we do not need to get attribute for everygrain.
+                        if (!checkedTypes.ContainsKey(data.GrainInstanceType))


This second if doesn't seem necessary.

gabikliot · 2016-05-18T04:55:35Z

Not sure why you need this ManagementFilterableGrain.
Instead pass type name string to the GetDetailedGrainStatistics function, to get counts only for grain of that type.
And we should have another mgmt function to retrieve all types.

Removed extra if in GetDetailedGrainStatistics method

…th the ManagementFilterableGrain attibute in the system. Refactored the GetDetailedGrainStatistics method to use GetGrainTypeList method to get the types to return.

Dewaldf · 2016-05-18T08:50:07Z

Just committed changes as suggested.

@gabikliot, The reason I decided to use the ManagementFilterableGrain attribute, is to make it easy for developers to get the grains they are interested in, the other option was to allow them to pass an array of Types into the GetDetailedGrainStatistics method, but that might get bloated if the developer wants to return a big list of grain types.

The GetGrainTypeList method that I added to the GrainTypeManager, can return a list of all grain types or we can filter out only the ManagementFilterable grains.

gabikliot · 2016-05-19T05:16:51Z

You have to think about the API in general terms, for all future usages and not just for your one particular case. The caller needs an ability to decide what grains he is interested in. And not the callee, which is in this case the grain itself. Grain developer can not know at the time he is writing the grain which client of the management interface will want what.

For example, look atIEnumerable.Where. You pass the filter function as a parameter by the caller, and not the other way around, which would be in analogy with what you suggested to have the items of IEnumerable to implement IFilterable.

In our case we want (at least) 2 function: get all grain types and get grains for a given type. That way the portal (the client of the management API) has the full flexibility and can for example iterate over all types and pick which ones he is interested in.
It is basically a standard API design principle.

gabikliot · 2016-05-19T05:17:32Z

src/Orleans/Core/GrainAttributes.cs

@@ -318,4 +318,9 @@ public ImplicitStreamSubscriptionAttribute(string streamNamespace)
            Namespace = streamNamespace;
        }
    }
+
+    [AttributeUsage(AttributeTargets.Class)]
+    public sealed class ManagementFilterableGrain : Attribute


As pointed out in the review this interface is un-necessary.

Added methods to get all active grain types on the ManagementGrain Changed methods to get active grains by passing in the types the developer would be interested in

Dewaldf · 2016-05-19T14:09:53Z

Committed the suggested changes.

sergeybykov · 2016-05-24T17:54:52Z

src/Orleans/SystemTargetInterfaces/IManagementGrain.cs

+        /// <param name="hostsIds">List of silos this command is to be sent to.</param>
+        /// <param name="types">Array of grain types to filter the results with</param>
+        /// <returns></returns>
+        Task<DetailedGrainStatistic[]> GetDetailedGrainStatistics(SiloAddress[] hostsIds, string[] types);


Wouldn't it be better to have a single method with default arguments?

GetDetailedGrainStatistics(string[] types = null, SiloAddress[] hostsIds=null)

where nulls mean all types and all silos respectively?

I would also flip the order of arguments assuming that specifying grain types would be a more common case than specifying a list of silos. That way GetDetailedGrainStatistics() and GetDetailedGrainStatistics(grainTypes) would be convenient shortcuts.

Dewaldf · 2016-05-24T18:58:17Z

I had the methods the way you suggested in the last comment, but then changed it because it was not consistent with the GetSimpleGrainStatistics method. I thought this was the way you guys preferred to have the overloads. Will make the changes shortly. :-)

sergeybykov · 2016-05-24T22:00:57Z

Sorry if I confused you. I didn't realize that was how it was already done. I still think a single method is better than 4 overloads. :-)

…ults of null. Changed the order of the parameter so that types is the firt param Changed GetActiveGrainTypes to be one method with default params instead of overload.

Dewaldf · 2016-05-25T07:44:14Z

No worries, I have just committed the changes as suggested.

GetActiveGrainTypes(SiloAddress[] hostsIds=null)
GetDetailedGrainStatistics(string[] types = null,SiloAddress[] hostsIds=null)

sergeybykov · 2016-05-25T20:57:34Z

Thank you, @Dewaldf!

Did you think about exposing this functionality via OrleansManager.exe?

Dewaldf · 2016-05-26T06:45:57Z

Hi,
This might be a bit late. We do not have a requirement to add this functionality to OrleansManager.exe. If you think this will add value then I will gladly add it there.

sergeybykov · 2016-05-27T16:52:36Z

I think it'd be better to keep OrleansManager.exe in sync with the ManagementGrain API. Thanks!

Dewaldf added 4 commits May 13, 2016 14:32

Adding extra methods to the management grain (GetDetailedGrainStatist…

ccddb87

…ics(SiloAddress[] hostsIds), GetDetailedGrainStatistics()) , that can be used to get more details about all the active grains.

Added attribute to allow the developer to specify what grains they wa…

a0f8892

…nt to be returned when GetDetailedGrainStatistics is called.

Merge branch 'master' of https://github.com/dotnet/orleans

a8f9ae0

Changed the GrainType in DetailedGrainstatisic to be a string, no use…

d250886

… in having the entire type object

dnfclas added the cla-required label May 17, 2016

dnfclas added cla-signed and removed cla-required labels May 17, 2016

Changed implementation of GetDetailedGrainStatistics to make sure tha…

b1b46cd

…t the attribute is not checked for every grain. Fixed code formatting.

sergeybykov reviewed May 17, 2016
View reviewed changes

Dewaldf and others added 2 commits May 18, 2016 08:05

Removed empty lines from ManagementFilterableGrain

197883a

Removed extra if in GetDetailedGrainStatistics method

Added method to GrainTypeManager to get all the types / only types wi…

103fe47

…th the ManagementFilterableGrain attibute in the system. Refactored the GetDetailedGrainStatistics method to use GetGrainTypeList method to get the types to return.

Removed unessecary whitespace

12da21e

jthelin added the enhancement label May 19, 2016

gabikliot reviewed May 19, 2016
View reviewed changes

Removed the ManagementFilterableGrain attribute

bcf0499

Added methods to get all active grain types on the ManagementGrain Changed methods to get active grains by passing in the types the developer would be interested in

sergeybykov reviewed May 24, 2016
View reviewed changes

sergeybykov self-assigned this May 24, 2016

Changed GetDetailedGrainStatistics methods to be one method with defa…

7f7680b

…ults of null. Changed the order of the parameter so that types is the firt param Changed GetActiveGrainTypes to be one method with default params instead of overload.

sergeybykov merged commit aa7fc5d into dotnet:master May 25, 2016

sergeybykov mentioned this pull request Oct 3, 2016

Active Grains List #1751

Closed

wuzhenda mentioned this pull request Sep 7, 2021

how to get all grain state #7266

Closed

github-actions bot locked and limited conversation to collaborators Dec 9, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Getting a list of active grains in Orleans for monitoring #1772

Getting a list of active grains in Orleans for monitoring #1772

Dewaldf commented May 17, 2016

dnfclas commented May 17, 2016

dnfclas commented May 17, 2016

sergeybykov May 17, 2016

gabikliot commented May 18, 2016

Dewaldf commented May 18, 2016

gabikliot commented May 19, 2016

gabikliot May 19, 2016

Dewaldf commented May 19, 2016

sergeybykov May 24, 2016

Dewaldf commented May 24, 2016

sergeybykov commented May 24, 2016

Dewaldf commented May 25, 2016

sergeybykov commented May 25, 2016

Dewaldf commented May 26, 2016

sergeybykov commented May 27, 2016

Getting a list of active grains in Orleans for monitoring #1772

Getting a list of active grains in Orleans for monitoring #1772

Conversation

Dewaldf commented May 17, 2016

dnfclas commented May 17, 2016

dnfclas commented May 17, 2016

sergeybykov May 17, 2016

Choose a reason for hiding this comment

gabikliot commented May 18, 2016

Dewaldf commented May 18, 2016

gabikliot commented May 19, 2016

gabikliot May 19, 2016

Choose a reason for hiding this comment

Dewaldf commented May 19, 2016

sergeybykov May 24, 2016

Choose a reason for hiding this comment

Dewaldf commented May 24, 2016

sergeybykov commented May 24, 2016

Dewaldf commented May 25, 2016

sergeybykov commented May 25, 2016

Dewaldf commented May 26, 2016

sergeybykov commented May 27, 2016