From: Piotr Hosowicz Date: Thu, 1 Jan 2009 13:01:01 +0000 (+0100) Subject: contrib/solaris-smf: Add Solaris SMF information to contrib/. X-Git-Tag: collectd-4.6.0~114 X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=fcebb154c10ca4cff71fbc0303928ac07a41aff3;p=collectd.git contrib/solaris-smf: Add Solaris SMF information to contrib/. See README or for details. Signed-off-by: Florian Forster --- diff --git a/contrib/solaris-smf/README b/contrib/solaris-smf/README new file mode 100644 index 00000000..dfd990b2 --- /dev/null +++ b/contrib/solaris-smf/README @@ -0,0 +1,331 @@ +SMF is the way Solaris 10 and later preferably manages services. It is intended +to replace the old init.d process and provides advances features, such as +automatic restarting of failing services. + +The following blog entry by Piotr Hosowicz describes the process in more +detail. The original entry can be found at +. + +The files in this directory are: + + README This file + collectd Start / stop script + collectd.xml SMF manifest for collectd. + +------------------------------------------------------------------------ + + SMF-izing collectd <#> + +Wpis na 0. poziomie, wysłany 21 grudnia 2008 o 16:30:49. + +My two previous blog entries were about building and running collectd + on Sun Solaris 10. After the first one Octo +contacted me and was so kind as to release a packaged version for x86_64 +. I have put aside the build +I rolled on my own and decided to install and run the packaged one on +the production servers. This blog entry is about SMF-izing the collectd +daemon. + +A few words about the SMF – the Solaris'es Service Management Facility. +I think it appeared in Solaris 10. From then on the good old |/etc/rcN.d +|| /etc/init.d| services are called /legacy services/. They still can be +run, but are not fully supported by SMF. SMF enables you to start and +stop services in the unified way, can direct you to man pages in case a +service enters maintenance mode, resolves dependencies between services, +can store properties of services and so on. A nice feature is that SMF +will take care of restarting services in case they terminate +unexpectedly, we will use it at the end to check that things are working +as they should. + +The 3V|L thing about SMF is that each service needs so called SMF +manifest written in XML and a script or scripts that are executed, when +the service needs to be stopped or started. It can be one script, which +should accept respective parameters. Even more 3V|L is the fact that the +manifest is imported into the SMF database and kept there in SQLite format. + +Below you will find collectd manifest and the script. I will post them +to collectd mailing list in matter of minutes with this blog entry +serving as a README. Please read all down to the bottom, including the +remarks. + +Manifest (based on the work of Kangurek, thanks!), see the "collectd.xml" +file: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Script, see the "collectd" file: + + +#!/sbin/sh + +PIDFILE=/opt/collectd/var/run/collectd.pid +DAEMON=/opt/collectd/sbin/collectd + +. /lib/svc/share/smf_include.sh + +case "$1" in + start) + if [ -f $PIDFILE ] ; then + echo "Already running. Stale PID file?" + PID=`cat $PIDFILE` + echo "$PIDFILE contains $PID" + ps -p $PID + exit $SMF_EXIT_ERR_FATAL + fi + $DAEMON + if [ $? -ne 0 ] ; then + echo $DAEMON faild to start + exit $SMF_EXIT_ERR_FATAL + fi + ;; + stop) + PID=`cat $PIDFILE 2>/dev/null` + kill -15 $PID 2>/dev/null + pwait $PID 1> /dev/null 2>/dev/null + ;; + restart) + $0 stop + $0 start + ;; + status) + ps -ef | grep collectd | grep -v status | grep -v grep + ;; + *) + echo "Usage: $0 [ start | stop | restart | status ]" + exit 1 + ;; +esac + + +exit $SMF_EXIT_OK + + + +So you have two files: |collectd| script and |collectd.xml| manifest. +What do you do with these files? + +First – before you begin – make sure that collectd is not running, close +it down. My script above assumes that you are using the default place +for PID file. Second: remove / move away collectd's |/etc/rcN.d| and +|/etc/init.d| stuff, you won't need it from now on, because collectd +will be SMF-ized. Tada! + +Next – install the script in place. It took me a minute or two to figure +out why Solaris'es |install| tool does not work as expected. It turned +out that the switches and parameters must be in exactly same order as in +man page, especially the -c parameter must be first: + +|# install -c /lib/svc/method/ -m 755 -u root -g bin collectd| + +Now is the moment to test once again that the script is working OK. Try +running: + +|# /lib/svc/method/collectd start +# /lib/svc/method/collectd stop +# /lib/svc/method/collectd restart +| + +|pgrep| and |kill| are your friends here, also collectd logs. At last +stop the collectd service and continue. + +Now is the time to /slurp/ attached XML manifest into the SMF database. +This is done using the |svccfg| tool. Transcript follows: + +|# svccfg +svc:> validate collectd.xml +svc:> import collectd.xml +svc:> +| + +It is good to run |validate| command first, especially if you copied and +pasted the XML manifest from this HTML document opened in your +browser!!! Second thing worth noting is that |svccfg| starts the service +immediately upon importing the manifest. It might be not what you want. +For example it will start collecting data on remote collectd server if +you use network plugin and it will do it under the hostname, that is not +right. So be sure to configure collectd prior to running it from SMF. + +Now a few words about SMF tools. To see the state of all services issue +|svcs -a| command. To see state of collectd service issue |svcs +collectd| command. Quite normal states are enabled and disabled. If you +see maintenance state then something is wrong. Be sure that you stopped +all non-SMF collectd processes before you follow the procedure described +here. To stop collectd the SMF way issue the |svcadm disable +collectd|command. To start collectd the SMF way issue the |svcadm enable +collectd|command. Be aware that setting it this way makes the change +persistent across OS reboots, if you want to enable / disable the +service only temporarily then add |-t| switch after the |enable| / +|disable| keywords. + +And now is time for a grand finale – seeing if SMF can take care of +collectd in case it crashes. See PID of collectd either using |pgrep| or +seeing the contents of the PID file and kill it using |kill|. Then check +with |svcs collectd| command that SMF has restarted collectd soon +afterwards. You should see that the service is once again enabled in the +first column, without your intervention. + +Things that could or should be clarified: + + * How hard is it to correct mistakes in manifests? Does svccfg just + overwrite entries for specified service FMRI or does it require to + delete bad entry (and how to do it?!) and import the correct one? + * How does SMF know that a service has crashed / terminated? I + attended Sun's trainings and the trainer didn't know how to + explain this, we formed a hypothesis that it watches new PIDs + after starting a service or something like that. I think it is a + bad hypothesis, because SMF can watch PID for the startup script + itself but I think not the processes launched inside the script. I + have a slight idea that it is done based on so called contracts. + +------------------------------------------------------------------------ + + + Komentarze do notki “SMF-izing collectd” <#comments> + + + Zostaw odpowiedź + +Nick + +------------------------------------------------------------------------ + + + Archiwum + + * Grudzień 2008 (5) + * Październik 2008 (4) + * Wrzesień 2008 (7) + * Sierpień 2008 (5) + * Lipiec 2008 (12) + * Czerwiec 2008 (11) + * Maj 2008 (3) + * Kwiecień 2008 (10) + * Marzec 2008 (3) + * Luty 2008 (1) + * Styczeń 2008 (1) + * Listopad 2007 (4) + * Październik 2007 (6) + * Wrzesień 2007 (10) + * Sierpień 2007 (3) + * Lipiec 2007 (8) + * Czerwiec 2007 (10) + * Maj 2007 (12) + * Kwiecień 2007 (17) + + + Kategorie + + * Film (8) + * Książki (35) + * Muzyka (15) + * Ogólne (20) + * Polityka (59) + * Sprzedam (5) + * Techblog (20) + * Technikalia (34) + * Wystawy (3) + + + Czytuję + + * ArsTechnica.com + * Fund. Orientacja + * Techblog Jogger'a + * The Register + + + Inne blogi + + * Bloody.Users + * Dandys + * Derin + * Kefir87 + * Klisu + * Kwantowe Krajobrazy + * Paczor + * Prestidigitator + * Remiq + * Torero + * Zdzichubg + + + Inne moje strony + + * www.delphi.org.pl + * www.hosowicz.com + + + Pajacyk.pl + + * Nakarm dzieci! + + + Meta + + * Panel administracyjny + + +------------------------------------------------------------------------ + +phosowicz is powered by Jogger and K2 + by Michael and +Chris , ported by Patryk Zawadzki. + +Notki w RSS + diff --git a/contrib/solaris-smf/collectd b/contrib/solaris-smf/collectd new file mode 100755 index 00000000..5ffdb243 --- /dev/null +++ b/contrib/solaris-smf/collectd @@ -0,0 +1,42 @@ +#!/sbin/sh + +PIDFILE=/opt/collectd/var/run/collectd.pid +DAEMON=/opt/collectd/sbin/collectd + +. /lib/svc/share/smf_include.sh + +case "$1" in + start) + if [ -f $PIDFILE ] ; then + echo "Already running. Stale PID file?" + PID=`cat $PIDFILE` + echo "$PIDFILE contains $PID" + ps -p $PID + exit $SMF_EXIT_ERR_FATAL + fi + $DAEMON + if [ $? -ne 0 ] ; then + echo $DAEMON faild to start + exit $SMF_EXIT_ERR_FATAL + fi + ;; + stop) + PID=`cat $PIDFILE 2>/dev/null` + kill -15 $PID 2>/dev/null + pwait $PID 1> /dev/null 2>/dev/null + ;; + restart) + $0 stop + $0 start + ;; + status) + ps -ef | grep collectd | grep -v status | grep -v grep + ;; + *) + echo "Usage: $0 [ start | stop | restart | status ]" + exit 1 + ;; +esac + + +exit $SMF_EXIT_OK diff --git a/contrib/solaris-smf/collectd.xml b/contrib/solaris-smf/collectd.xml new file mode 100644 index 00000000..d1ae3a46 --- /dev/null +++ b/contrib/solaris-smf/collectd.xml @@ -0,0 +1,56 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +