diff options
author | Melanie Thielker | 2017-03-31 13:46:01 +0100 |
---|---|---|
committer | Melanie Thielker | 2017-03-31 14:38:41 +0100 |
commit | 75915bd0f3be487a0fa05e4a91d46b23b488ce82 (patch) | |
tree | 3a8c7000a27d697afcd982584e0aa5b9e07ba515 /OpenSim | |
parent | Make the MySqlGeneric layer transaction aware (diff) | |
download | opensim-SC_OLD-75915bd0f3be487a0fa05e4a91d46b23b488ce82.zip opensim-SC_OLD-75915bd0f3be487a0fa05e4a91d46b23b488ce82.tar.gz opensim-SC_OLD-75915bd0f3be487a0fa05e4a91d46b23b488ce82.tar.bz2 opensim-SC_OLD-75915bd0f3be487a0fa05e4a91d46b23b488ce82.tar.xz |
Add the ability to post to and act uponconfiguration in etcd
Etcd is a distributed, highly available name-value store that is
the basis of many clustered applications. However, it can also be
run on a standalone machine. Using etcd allows live monitoring
and possibly changing configuration while the sim is running.
Diffstat (limited to 'OpenSim')
3 files changed, 276 insertions, 3 deletions
diff --git a/OpenSim/Region/Framework/Interfaces/IEtcdModule.cs b/OpenSim/Region/Framework/Interfaces/IEtcdModule.cs new file mode 100644 index 0000000..123cb67 --- /dev/null +++ b/OpenSim/Region/Framework/Interfaces/IEtcdModule.cs | |||
@@ -0,0 +1,37 @@ | |||
1 | /* | ||
2 | * Copyright (c) Contributors, http://opensimulator.org/ | ||
3 | * See CONTRIBUTORS.TXT for a full list of copyright holders. | ||
4 | * | ||
5 | * Redistribution and use in source and binary forms, with or without | ||
6 | * modification, are permitted provided that the following conditions are met: | ||
7 | * * Redistributions of source code must retain the above copyright | ||
8 | * notice, this list of conditions and the following disclaimer. | ||
9 | * * Redistributions in binary form must reproduce the above copyright | ||
10 | * notice, this list of conditions and the following disclaimer in the | ||
11 | * documentation and/or other materials provided with the distribution. | ||
12 | * * Neither the name of the OpenSimulator Project nor the | ||
13 | * names of its contributors may be used to endorse or promote products | ||
14 | * derived from this software without specific prior written permission. | ||
15 | * | ||
16 | * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY | ||
17 | * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED | ||
18 | * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | ||
19 | * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY | ||
20 | * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | ||
21 | * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | ||
22 | * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND | ||
23 | * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
24 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | ||
25 | * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
26 | */ | ||
27 | |||
28 | using System; | ||
29 | |||
30 | public interface IEtcdModule | ||
31 | { | ||
32 | bool Store(string k, string v); | ||
33 | bool Store(string k, string v, int ttl); | ||
34 | string Get(string k); | ||
35 | void Watch(string k, Action<string> callback); | ||
36 | void Delete(string k); | ||
37 | } | ||
diff --git a/OpenSim/Region/Framework/Scenes/Scene.cs b/OpenSim/Region/Framework/Scenes/Scene.cs index f4bf0b2..fd13821 100755 --- a/OpenSim/Region/Framework/Scenes/Scene.cs +++ b/OpenSim/Region/Framework/Scenes/Scene.cs | |||
@@ -540,6 +540,9 @@ namespace OpenSim.Region.Framework.Scenes | |||
540 | private Timer m_mapGenerationTimer = new Timer(); | 540 | private Timer m_mapGenerationTimer = new Timer(); |
541 | private bool m_generateMaptiles; | 541 | private bool m_generateMaptiles; |
542 | 542 | ||
543 | protected int m_lastHealth = -1; | ||
544 | protected int m_lastUsers = -1; | ||
545 | |||
543 | #endregion Fields | 546 | #endregion Fields |
544 | 547 | ||
545 | #region Properties | 548 | #region Properties |
@@ -1234,6 +1237,8 @@ namespace OpenSim.Region.Framework.Scenes | |||
1234 | } | 1237 | } |
1235 | } | 1238 | } |
1236 | } | 1239 | } |
1240 | |||
1241 | StartTimerWatchdog(); | ||
1237 | } | 1242 | } |
1238 | 1243 | ||
1239 | public Scene(RegionInfo regInfo) | 1244 | public Scene(RegionInfo regInfo) |
@@ -1504,6 +1509,14 @@ namespace OpenSim.Region.Framework.Scenes | |||
1504 | return; | 1509 | return; |
1505 | } | 1510 | } |
1506 | 1511 | ||
1512 | IEtcdModule etcd = RequestModuleInterface<IEtcdModule>(); | ||
1513 | if (etcd != null) | ||
1514 | { | ||
1515 | etcd.Delete("Health"); | ||
1516 | etcd.Delete("HealthFlags"); | ||
1517 | etcd.Delete("RootAgents"); | ||
1518 | } | ||
1519 | |||
1507 | m_log.InfoFormat("[SCENE]: Closing down the single simulator: {0}", RegionInfo.RegionName); | 1520 | m_log.InfoFormat("[SCENE]: Closing down the single simulator: {0}", RegionInfo.RegionName); |
1508 | 1521 | ||
1509 | 1522 | ||
@@ -5536,23 +5549,24 @@ Label_GroupsDone: | |||
5536 | return 0; | 5549 | return 0; |
5537 | } | 5550 | } |
5538 | 5551 | ||
5539 | if ((Util.EnvironmentTickCountSubtract(m_lastFrameTick)) < 1000) | 5552 | if ((Util.EnvironmentTickCountSubtract(m_lastFrameTick)) < 2000) |
5540 | { | 5553 | { |
5541 | health+=1; | 5554 | health+=1; |
5542 | flags |= 1; | 5555 | flags |= 1; |
5543 | } | 5556 | } |
5544 | 5557 | ||
5545 | if (Util.EnvironmentTickCountSubtract(m_lastIncoming) < 1000) | 5558 | if (Util.EnvironmentTickCountSubtract(m_lastIncoming) < 2000) |
5546 | { | 5559 | { |
5547 | health+=1; | 5560 | health+=1; |
5548 | flags |= 2; | 5561 | flags |= 2; |
5549 | } | 5562 | } |
5550 | 5563 | ||
5551 | if (Util.EnvironmentTickCountSubtract(m_lastOutgoing) < 1000) | 5564 | if (Util.EnvironmentTickCountSubtract(m_lastOutgoing) < 2000) |
5552 | { | 5565 | { |
5553 | health+=1; | 5566 | health+=1; |
5554 | flags |= 4; | 5567 | flags |= 4; |
5555 | } | 5568 | } |
5569 | /* | ||
5556 | else | 5570 | else |
5557 | { | 5571 | { |
5558 | int pid = System.Diagnostics.Process.GetCurrentProcess().Id; | 5572 | int pid = System.Diagnostics.Process.GetCurrentProcess().Id; |
@@ -5565,6 +5579,7 @@ proc.WaitForExit(); | |||
5565 | Thread.Sleep(1000); | 5579 | Thread.Sleep(1000); |
5566 | Environment.Exit(1); | 5580 | Environment.Exit(1); |
5567 | } | 5581 | } |
5582 | */ | ||
5568 | 5583 | ||
5569 | if (flags != 7) | 5584 | if (flags != 7) |
5570 | return health; | 5585 | return health; |
@@ -6329,6 +6344,32 @@ Environment.Exit(1); | |||
6329 | public void TimerWatchdog(object sender, ElapsedEventArgs e) | 6344 | public void TimerWatchdog(object sender, ElapsedEventArgs e) |
6330 | { | 6345 | { |
6331 | CheckHeartbeat(); | 6346 | CheckHeartbeat(); |
6347 | |||
6348 | IEtcdModule etcd = RequestModuleInterface<IEtcdModule>(); | ||
6349 | int flags; | ||
6350 | string message; | ||
6351 | if (etcd != null) | ||
6352 | { | ||
6353 | int health = GetHealth(out flags, out message); | ||
6354 | if (health != m_lastHealth) | ||
6355 | { | ||
6356 | m_lastHealth = health; | ||
6357 | |||
6358 | etcd.Store("Health", health.ToString(), 300000); | ||
6359 | etcd.Store("HealthFlags", flags.ToString(), 300000); | ||
6360 | } | ||
6361 | |||
6362 | int roots = 0; | ||
6363 | foreach (ScenePresence sp in GetScenePresences()) | ||
6364 | if (!sp.IsChildAgent && !sp.IsNPC) | ||
6365 | roots++; | ||
6366 | |||
6367 | if (m_lastUsers != roots) | ||
6368 | { | ||
6369 | m_lastUsers = roots; | ||
6370 | etcd.Store("RootAgents", roots.ToString(), 300000); | ||
6371 | } | ||
6372 | } | ||
6332 | } | 6373 | } |
6333 | 6374 | ||
6334 | /// This method deals with movement when an avatar is automatically moving (but this is distinct from the | 6375 | /// This method deals with movement when an avatar is automatically moving (but this is distinct from the |
diff --git a/OpenSim/Region/OptionalModules/Framework/Monitoring/EtcdMonitoringModule.cs b/OpenSim/Region/OptionalModules/Framework/Monitoring/EtcdMonitoringModule.cs new file mode 100644 index 0000000..921bbfb --- /dev/null +++ b/OpenSim/Region/OptionalModules/Framework/Monitoring/EtcdMonitoringModule.cs | |||
@@ -0,0 +1,195 @@ | |||
1 | /* | ||
2 | * Copyright (c) Contributors, http://opensimulator.org/ | ||
3 | * See CONTRIBUTORS.TXT for a full list of copyright holders. | ||
4 | * | ||
5 | * Redistribution and use in source and binary forms, with or without | ||
6 | * modification, are permitted provided that the following conditions are met: | ||
7 | * * Redistributions of source code must retain the above copyright | ||
8 | * notice, this list of conditions and the following disclaimer. | ||
9 | * * Redistributions in binary form must reproduce the above copyright | ||
10 | * notice, this list of conditions and the following disclaimer in the | ||
11 | * documentation and/or other materials provided with the distribution. | ||
12 | * * Neither the name of the OpenSimulator Project nor the | ||
13 | * names of its contributors may be used to endorse or promote products | ||
14 | * derived from this software without specific prior written permission. | ||
15 | * | ||
16 | * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY | ||
17 | * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED | ||
18 | * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | ||
19 | * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY | ||
20 | * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | ||
21 | * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | ||
22 | * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND | ||
23 | * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
24 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | ||
25 | * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
26 | */ | ||
27 | |||
28 | using System; | ||
29 | using System.Collections.Generic; | ||
30 | using System.Reflection; | ||
31 | using System.Text; | ||
32 | using log4net; | ||
33 | using Mono.Addins; | ||
34 | using Nini.Config; | ||
35 | using OpenMetaverse; | ||
36 | using OpenSim.Framework; | ||
37 | using OpenSim.Framework.Console; | ||
38 | using OpenSim.Region.Framework.Interfaces; | ||
39 | using OpenSim.Region.Framework.Scenes; | ||
40 | using netcd; | ||
41 | using netcd.Serialization; | ||
42 | using netcd.Advanced; | ||
43 | using netcd.Advanced.Requests; | ||
44 | |||
45 | namespace OpenSim.Region.OptionalModules.Framework.Monitoring | ||
46 | { | ||
47 | /// <summary> | ||
48 | /// Allows to store monitoring data in etcd, a high availability | ||
49 | /// name-value store. | ||
50 | /// </summary> | ||
51 | [Extension(Path = "/OpenSim/RegionModules", NodeName = "RegionModule", Id = "EtcdMonitoringModule")] | ||
52 | public class EtcdMonitoringModule : INonSharedRegionModule, IEtcdModule | ||
53 | { | ||
54 | private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType); | ||
55 | |||
56 | protected Scene m_scene; | ||
57 | protected IEtcdClient m_client; | ||
58 | protected bool m_enabled = false; | ||
59 | protected string m_etcdBasePath = String.Empty; | ||
60 | protected bool m_appendRegionID = true; | ||
61 | |||
62 | public string Name | ||
63 | { | ||
64 | get { return "EtcdMonitoringModule"; } | ||
65 | } | ||
66 | |||
67 | public Type ReplaceableInterface | ||
68 | { | ||
69 | get { return null; } | ||
70 | } | ||
71 | |||
72 | public void Initialise(IConfigSource source) | ||
73 | { | ||
74 | if (source.Configs["Etcd"] == null) | ||
75 | return; | ||
76 | |||
77 | IConfig etcdConfig = source.Configs["Etcd"]; | ||
78 | |||
79 | string etcdUrls = etcdConfig.GetString("EtcdUrls", String.Empty); | ||
80 | if (etcdUrls == String.Empty) | ||
81 | return; | ||
82 | |||
83 | m_etcdBasePath = etcdConfig.GetString("BasePath", m_etcdBasePath); | ||
84 | m_appendRegionID = etcdConfig.GetBoolean("AppendRegionID", m_appendRegionID); | ||
85 | |||
86 | if (!m_etcdBasePath.EndsWith("/")) | ||
87 | m_etcdBasePath += "/"; | ||
88 | |||
89 | try | ||
90 | { | ||
91 | string[] endpoints = etcdUrls.Split(new char[] {','}); | ||
92 | List<Uri> uris = new List<Uri>(); | ||
93 | foreach (string endpoint in endpoints) | ||
94 | uris.Add(new Uri(endpoint.Trim())); | ||
95 | |||
96 | m_client = new EtcdClient(uris.ToArray(), new DefaultSerializer(), new DefaultSerializer()); | ||
97 | } | ||
98 | catch (Exception e) | ||
99 | { | ||
100 | m_log.DebugFormat("[ETCD]: Error initializing connection: " + e.ToString()); | ||
101 | return; | ||
102 | } | ||
103 | |||
104 | m_log.DebugFormat("[ETCD]: Etcd module configured"); | ||
105 | m_enabled = true; | ||
106 | } | ||
107 | |||
108 | public void Close() | ||
109 | { | ||
110 | //m_client = null; | ||
111 | m_scene = null; | ||
112 | } | ||
113 | |||
114 | public void AddRegion(Scene scene) | ||
115 | { | ||
116 | m_scene = scene; | ||
117 | |||
118 | if (m_enabled) | ||
119 | { | ||
120 | if (m_appendRegionID) | ||
121 | m_etcdBasePath += m_scene.RegionInfo.RegionID.ToString() + "/"; | ||
122 | |||
123 | m_log.DebugFormat("[ETCD]: Using base path {0} for all keys", m_etcdBasePath); | ||
124 | |||
125 | try | ||
126 | { | ||
127 | m_client.Advanced.CreateDirectory(new CreateDirectoryRequest() {Key = m_etcdBasePath}); | ||
128 | } | ||
129 | catch (Exception e) | ||
130 | { | ||
131 | m_log.ErrorFormat("Exception trying to create base path {0}: " + e.ToString(), m_etcdBasePath); | ||
132 | } | ||
133 | |||
134 | scene.RegisterModuleInterface<IEtcdModule>(this); | ||
135 | } | ||
136 | } | ||
137 | |||
138 | public void RemoveRegion(Scene scene) | ||
139 | { | ||
140 | } | ||
141 | |||
142 | public void RegionLoaded(Scene scene) | ||
143 | { | ||
144 | } | ||
145 | |||
146 | public bool Store(string k, string v) | ||
147 | { | ||
148 | return Store(k, v, 0); | ||
149 | } | ||
150 | |||
151 | public bool Store(string k, string v, int ttl) | ||
152 | { | ||
153 | Response resp = m_client.Advanced.SetKey(new SetKeyRequest() { Key = m_etcdBasePath + k, Value = v, TimeToLive = ttl }); | ||
154 | |||
155 | if (resp == null) | ||
156 | return false; | ||
157 | |||
158 | if (resp.ErrorCode.HasValue) | ||
159 | { | ||
160 | m_log.DebugFormat("[ETCD]: Error {0} ({1}) storing {2} => {3}", resp.Cause, (int)resp.ErrorCode, m_etcdBasePath + k, v); | ||
161 | |||
162 | return false; | ||
163 | } | ||
164 | |||
165 | return true; | ||
166 | } | ||
167 | |||
168 | public string Get(string k) | ||
169 | { | ||
170 | Response resp = m_client.Advanced.GetKey(new GetKeyRequest() { Key = m_etcdBasePath + k }); | ||
171 | |||
172 | if (resp == null) | ||
173 | return String.Empty; | ||
174 | |||
175 | if (resp.ErrorCode.HasValue) | ||
176 | { | ||
177 | m_log.DebugFormat("[ETCD]: Error {0} ({1}) getting {2}", resp.Cause, (int)resp.ErrorCode, m_etcdBasePath + k); | ||
178 | |||
179 | return String.Empty; | ||
180 | } | ||
181 | |||
182 | return resp.Node.Value; | ||
183 | } | ||
184 | |||
185 | public void Delete(string k) | ||
186 | { | ||
187 | m_client.Advanced.DeleteKey(new DeleteKeyRequest() { Key = m_etcdBasePath + k }); | ||
188 | } | ||
189 | |||
190 | public void Watch(string k, Action<string> callback) | ||
191 | { | ||
192 | m_client.Advanced.WatchKey(new WatchKeyRequest() { Key = m_etcdBasePath + k, Callback = (x) => { callback(x.Node.Value); } }); | ||
193 | } | ||
194 | } | ||
195 | } | ||