Skip to content
This repository was archived by the owner on Mar 13, 2022. It is now read-only.

Keep the watch action working forever - #36

Merged
mbohlool merged 2 commits into
kubernetes-client:masterfrom
lichen2013:keep_watch
Jan 10, 2018
Merged

Keep the watch action working forever#36
mbohlool merged 2 commits into
kubernetes-client:masterfrom
lichen2013:keep_watch

Conversation

@lichen2013

Copy link
Copy Markdown

@codecov-io

codecov-io commented Oct 17, 2017

Copy link
Copy Markdown

Codecov Report

Merging #36 into master will increase coverage by 0.23%.
The diff coverage is 100%.

Impacted file tree graph

@@ Coverage Diff @@## master #36 +/- ##
==========================================
+ Coverage 93.36% 93.59% +0.23% 
==========================================
Files 11 11 Lines 829 859 +30 ==========================================
+ Hits 774 804 +30 
Misses 55 55
Impacted FilesCoverage Δ
watch/watch_test.py97.95% <100%> (+0.59%)⬆️
watch/watch.py100% <100%> (ø)⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9213876...aec1c52. Read the comment docs.

@lichen2013
lichen2013force-pushed the keep_watch branch 2 times, most recently from 48223bf to 4f815d4CompareOctober 17, 2017 08:49
Comment threadwatch/watch.py Outdated
resp.close()
resp.release_conn()

if not keep or self._stop:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will result in all cached event to be delivered again. If we want to reconnect, we should catch the last resourceVersion and pass it to the watch call to make sure we continue receiving new events not old cached events. Also would be nice if we can fix this at root too (find the reason for timeout in http client and fix that). I think the server keeps the connection alive and it is the client that has a pre-defined timeout somewhere.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!
Let me do a little more checks.

@karmabkarmabOct 18, 2017

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for what it's worth, i indeed got this same kind of issue solved using @mbohlool recommendation and this kind of snippet:

DOMAIN="kool.karmalabs.local"
....
resource_version=NonewhileTrue:
ifresource_versionisNone:
stream=watch.Watch().stream(crds.list_cluster_custom_object, DOMAIN, "v1", "guitars")
else:
stream=watch.Watch().stream(crds.list_cluster_custom_object, DOMAIN, "v1", "guitars", resource_version=resource_version)
foreventinstream:
obj=event["object"]
metadata=obj.get("metadata")
resource_version=metadata['resourceVersion']
....

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some updates for the timeout setting:

There are two inputs available in the client can set timeouts:

a) timeout_seconds: This value will not used by client but included in the URL:

https://localhost:6443/api/v1/namespaces/default/pods?labelSelector=app%3Ddemo&timeoutSeconds=100&watch=True.

So, this setting is actually used by server.

b) _request_timeout

This can accept 2 type inputs, int or tuple with length equals to 2, checked at

kubernetes.client.rest.RESTClientObject.request()

The value will eventually set to the socket used for the connection.
b.1) if the input is tuple, the first value will actually been ignored.
b.2) when timeout happens, an exception will be raised, for example:

urllib3.exceptions.ReadTimeoutError: HTTPSConnectionPool(host='localhost', port=6443): Read timed out.

b.3) when the value is not set, the default value is None, socket has no timeout.

https://docs.python.org/2/library/socket.html#socket.getdefaulttimeout

Haven't figure out where/how server sets timeout, but I believe when we leave both timeout settings empty, client will keeps the connection alive.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice update on the timeout. timeout_seconds is what server expect for watch calls and if you don't set it, it won't timeout the connection. There is a hidden timeout on the request that fortunately the generated client don't know about and cannot set.

Even with not setting the timeout, the connection can fail or network can fail and it is a good idea to have this flag if we make it smart enough to continue the watch using resource_version.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you explain a little more about the "There is a hidden timeout on the request that fortunately the generated client don't know about and cannot set". Really courious about this....

@lichen2013lichen2013Oct 26, 2017

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Continue the watch using resource_version updated.
Also, I did a little change. Since we already have "timeout_seconds" to let user set the timeouts, when the value is empty, I suppose this means watch forever, no extra flag is needed.

@lichen2013
lichen2013force-pushed the keep_watch branch 3 times, most recently from 14847ad to ff02e98CompareOctober 26, 2017 08:20
@lichen2013lichen2013 changed the title Add flag to enable keep the watch action working all the timeKeep the watch action working foreverOct 26, 2017
Comment threadwatch/watch.py
resp.close()
resp.release_conn()

if timeouts or self._stop:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What if the user set timeouts but it has not been passed yet?

@lichen2013lichen2013Oct 31, 2017

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm still trying to find the proof that the exit happens we saw at the beginning is caused by the client side.

I do find the flag 'min-request-timeout' in doc kube-apiserver, and it is said that the apiserver actually has a timeout setting by itself:

--min-request-timeout=1800: An optional field indicating the minimum number of seconds a handler must keep a request open before timing it out. Currently only honored by the watch request handler, which picks a randomized value above this number as the connection timeout, to spread out load.

And if it is not set, the default value is 1800:

https://github.com/kubernetes/apiserver/blob/master/pkg/server/config.go#L248

MinRequestTimeout: 1800,

So, base on what I know now: I don't think timeout will happen before the timeouts setting.

@mbohlool

Copy link
Copy Markdown
Contributor

@lichen2013 This looks very good. Only one comment, otherwise good to go.

@mbohlool

Copy link
Copy Markdown
Contributor

@lichen2013 Only remaining item here is to reconnect if the user specified timeout is not passed yet (in addition to the case of not setting timeout which reconnect the watch always). I would want to include this in 4.0 client but that needs to be done soon.

Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@lichen2013@codecov-io@mbohlool@karmab
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Keep the watch action working forever by lichen2013 · Pull Request #36 · kubernetes-client/python-base · GitHub
Skip to content
This repository was archived by the owner on Mar 13, 2022. It is now read-only.

Keep the watch action working forever - #36

Merged
mbohlool merged 2 commits into
kubernetes-client:masterfrom
lichen2013:keep_watch
Jan 10, 2018
Merged

Keep the watch action working forever#36
mbohlool merged 2 commits into
kubernetes-client:masterfrom
lichen2013:keep_watch

Conversation

@lichen2013

Copy link
Copy Markdown

@codecov-io

codecov-io commented Oct 17, 2017

Copy link
Copy Markdown

Codecov Report

Merging #36 into master will increase coverage by 0.23%.
The diff coverage is 100%.

Impacted file tree graph

@@ Coverage Diff @@## master #36 +/- ##
==========================================
+ Coverage 93.36% 93.59% +0.23% 
==========================================
Files 11 11 Lines 829 859 +30 ==========================================
+ Hits 774 804 +30 
Misses 55 55
Impacted FilesCoverage Δ
watch/watch_test.py97.95% <100%> (+0.59%)⬆️
watch/watch.py100% <100%> (ø)⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9213876...aec1c52. Read the comment docs.

@lichen2013
lichen2013force-pushed the keep_watch branch 2 times, most recently from 48223bf to 4f815d4CompareOctober 17, 2017 08:49
Comment threadwatch/watch.py Outdated
resp.close()
resp.release_conn()

if not keep or self._stop:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will result in all cached event to be delivered again. If we want to reconnect, we should catch the last resourceVersion and pass it to the watch call to make sure we continue receiving new events not old cached events. Also would be nice if we can fix this at root too (find the reason for timeout in http client and fix that). I think the server keeps the connection alive and it is the client that has a pre-defined timeout somewhere.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!
Let me do a little more checks.

@karmabkarmabOct 18, 2017

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for what it's worth, i indeed got this same kind of issue solved using @mbohlool recommendation and this kind of snippet:

DOMAIN="kool.karmalabs.local"
....
resource_version=NonewhileTrue:
ifresource_versionisNone:
stream=watch.Watch().stream(crds.list_cluster_custom_object, DOMAIN, "v1", "guitars")
else:
stream=watch.Watch().stream(crds.list_cluster_custom_object, DOMAIN, "v1", "guitars", resource_version=resource_version)
foreventinstream:
obj=event["object"]
metadata=obj.get("metadata")
resource_version=metadata['resourceVersion']
....

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some updates for the timeout setting:

There are two inputs available in the client can set timeouts:

a) timeout_seconds: This value will not used by client but included in the URL:

https://localhost:6443/api/v1/namespaces/default/pods?labelSelector=app%3Ddemo&timeoutSeconds=100&watch=True.

So, this setting is actually used by server.

b) _request_timeout

This can accept 2 type inputs, int or tuple with length equals to 2, checked at

kubernetes.client.rest.RESTClientObject.request()

The value will eventually set to the socket used for the connection.
b.1) if the input is tuple, the first value will actually been ignored.
b.2) when timeout happens, an exception will be raised, for example:

urllib3.exceptions.ReadTimeoutError: HTTPSConnectionPool(host='localhost', port=6443): Read timed out.

b.3) when the value is not set, the default value is None, socket has no timeout.

https://docs.python.org/2/library/socket.html#socket.getdefaulttimeout

Haven't figure out where/how server sets timeout, but I believe when we leave both timeout settings empty, client will keeps the connection alive.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice update on the timeout. timeout_seconds is what server expect for watch calls and if you don't set it, it won't timeout the connection. There is a hidden timeout on the request that fortunately the generated client don't know about and cannot set.

Even with not setting the timeout, the connection can fail or network can fail and it is a good idea to have this flag if we make it smart enough to continue the watch using resource_version.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you explain a little more about the "There is a hidden timeout on the request that fortunately the generated client don't know about and cannot set". Really courious about this....

@lichen2013lichen2013Oct 26, 2017

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Continue the watch using resource_version updated.
Also, I did a little change. Since we already have "timeout_seconds" to let user set the timeouts, when the value is empty, I suppose this means watch forever, no extra flag is needed.

@lichen2013
lichen2013force-pushed the keep_watch branch 3 times, most recently from 14847ad to ff02e98CompareOctober 26, 2017 08:20
@lichen2013lichen2013 changed the title Add flag to enable keep the watch action working all the timeKeep the watch action working foreverOct 26, 2017
Comment threadwatch/watch.py
resp.close()
resp.release_conn()

if timeouts or self._stop:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What if the user set timeouts but it has not been passed yet?

@lichen2013lichen2013Oct 31, 2017

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm still trying to find the proof that the exit happens we saw at the beginning is caused by the client side.

I do find the flag 'min-request-timeout' in doc kube-apiserver, and it is said that the apiserver actually has a timeout setting by itself:

--min-request-timeout=1800: An optional field indicating the minimum number of seconds a handler must keep a request open before timing it out. Currently only honored by the watch request handler, which picks a randomized value above this number as the connection timeout, to spread out load.

And if it is not set, the default value is 1800:

https://github.com/kubernetes/apiserver/blob/master/pkg/server/config.go#L248

MinRequestTimeout: 1800,

So, base on what I know now: I don't think timeout will happen before the timeouts setting.

@mbohlool

Copy link
Copy Markdown
Contributor

@lichen2013 This looks very good. Only one comment, otherwise good to go.

@mbohlool

Copy link
Copy Markdown
Contributor

@lichen2013 Only remaining item here is to reconnect if the user specified timeout is not passed yet (in addition to the case of not setting timeout which reconnect the watch always). I would want to include this in 4.0 client but that needs to be done soon.

Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@lichen2013@codecov-io@mbohlool@karmab
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Keep the watch action working forever by lichen2013 · Pull Request #36 · kubernetes-client/python-base · GitHub
Skip to content
This repository was archived by the owner on Mar 13, 2022. It is now read-only.

Keep the watch action working forever - #36

Merged
mbohlool merged 2 commits into
kubernetes-client:masterfrom
lichen2013:keep_watch
Jan 10, 2018
Merged

Keep the watch action working forever#36
mbohlool merged 2 commits into
kubernetes-client:masterfrom
lichen2013:keep_watch

Conversation

@lichen2013

Copy link
Copy Markdown

@codecov-io

codecov-io commented Oct 17, 2017

Copy link
Copy Markdown

Codecov Report

Merging #36 into master will increase coverage by 0.23%.
The diff coverage is 100%.

Impacted file tree graph

@@ Coverage Diff @@## master #36 +/- ##
==========================================
+ Coverage 93.36% 93.59% +0.23% 
==========================================
Files 11 11 Lines 829 859 +30 ==========================================
+ Hits 774 804 +30 
Misses 55 55
Impacted FilesCoverage Δ
watch/watch_test.py97.95% <100%> (+0.59%)⬆️
watch/watch.py100% <100%> (ø)⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9213876...aec1c52. Read the comment docs.

@lichen2013
lichen2013force-pushed the keep_watch branch 2 times, most recently from 48223bf to 4f815d4CompareOctober 17, 2017 08:49
Comment threadwatch/watch.py Outdated
resp.close()
resp.release_conn()

if not keep or self._stop:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will result in all cached event to be delivered again. If we want to reconnect, we should catch the last resourceVersion and pass it to the watch call to make sure we continue receiving new events not old cached events. Also would be nice if we can fix this at root too (find the reason for timeout in http client and fix that). I think the server keeps the connection alive and it is the client that has a pre-defined timeout somewhere.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!
Let me do a little more checks.

@karmabkarmabOct 18, 2017

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for what it's worth, i indeed got this same kind of issue solved using @mbohlool recommendation and this kind of snippet:

DOMAIN="kool.karmalabs.local"
....
resource_version=NonewhileTrue:
ifresource_versionisNone:
stream=watch.Watch().stream(crds.list_cluster_custom_object, DOMAIN, "v1", "guitars")
else:
stream=watch.Watch().stream(crds.list_cluster_custom_object, DOMAIN, "v1", "guitars", resource_version=resource_version)
foreventinstream:
obj=event["object"]
metadata=obj.get("metadata")
resource_version=metadata['resourceVersion']
....

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some updates for the timeout setting:

There are two inputs available in the client can set timeouts:

a) timeout_seconds: This value will not used by client but included in the URL:

https://localhost:6443/api/v1/namespaces/default/pods?labelSelector=app%3Ddemo&timeoutSeconds=100&watch=True.

So, this setting is actually used by server.

b) _request_timeout

This can accept 2 type inputs, int or tuple with length equals to 2, checked at

kubernetes.client.rest.RESTClientObject.request()

The value will eventually set to the socket used for the connection.
b.1) if the input is tuple, the first value will actually been ignored.
b.2) when timeout happens, an exception will be raised, for example:

urllib3.exceptions.ReadTimeoutError: HTTPSConnectionPool(host='localhost', port=6443): Read timed out.

b.3) when the value is not set, the default value is None, socket has no timeout.

https://docs.python.org/2/library/socket.html#socket.getdefaulttimeout

Haven't figure out where/how server sets timeout, but I believe when we leave both timeout settings empty, client will keeps the connection alive.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice update on the timeout. timeout_seconds is what server expect for watch calls and if you don't set it, it won't timeout the connection. There is a hidden timeout on the request that fortunately the generated client don't know about and cannot set.

Even with not setting the timeout, the connection can fail or network can fail and it is a good idea to have this flag if we make it smart enough to continue the watch using resource_version.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you explain a little more about the "There is a hidden timeout on the request that fortunately the generated client don't know about and cannot set". Really courious about this....

@lichen2013lichen2013Oct 26, 2017

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Continue the watch using resource_version updated.
Also, I did a little change. Since we already have "timeout_seconds" to let user set the timeouts, when the value is empty, I suppose this means watch forever, no extra flag is needed.

@lichen2013
lichen2013force-pushed the keep_watch branch 3 times, most recently from 14847ad to ff02e98CompareOctober 26, 2017 08:20
@lichen2013lichen2013 changed the title Add flag to enable keep the watch action working all the timeKeep the watch action working foreverOct 26, 2017
Comment threadwatch/watch.py
resp.close()
resp.release_conn()

if timeouts or self._stop:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What if the user set timeouts but it has not been passed yet?

@lichen2013lichen2013Oct 31, 2017

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm still trying to find the proof that the exit happens we saw at the beginning is caused by the client side.

I do find the flag 'min-request-timeout' in doc kube-apiserver, and it is said that the apiserver actually has a timeout setting by itself:

--min-request-timeout=1800: An optional field indicating the minimum number of seconds a handler must keep a request open before timing it out. Currently only honored by the watch request handler, which picks a randomized value above this number as the connection timeout, to spread out load.

And if it is not set, the default value is 1800:

https://github.com/kubernetes/apiserver/blob/master/pkg/server/config.go#L248

MinRequestTimeout: 1800,

So, base on what I know now: I don't think timeout will happen before the timeouts setting.

@mbohlool

Copy link
Copy Markdown
Contributor

@lichen2013 This looks very good. Only one comment, otherwise good to go.

@mbohlool

Copy link
Copy Markdown
Contributor

@lichen2013 Only remaining item here is to reconnect if the user specified timeout is not passed yet (in addition to the case of not setting timeout which reconnect the watch always). I would want to include this in 4.0 client but that needs to be done soon.

Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@lichen2013@codecov-io@mbohlool@karmab
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Keep the watch action working forever by lichen2013 · Pull Request #36 · kubernetes-client/python-base · GitHub
Skip to content
This repository was archived by the owner on Mar 13, 2022. It is now read-only.

Keep the watch action working forever - #36

Merged
mbohlool merged 2 commits into
kubernetes-client:masterfrom
lichen2013:keep_watch
Jan 10, 2018
Merged

Keep the watch action working forever#36
mbohlool merged 2 commits into
kubernetes-client:masterfrom
lichen2013:keep_watch

Conversation

@lichen2013

Copy link
Copy Markdown

@codecov-io

codecov-io commented Oct 17, 2017

Copy link
Copy Markdown

Codecov Report

Merging #36 into master will increase coverage by 0.23%.
The diff coverage is 100%.

Impacted file tree graph

@@ Coverage Diff @@## master #36 +/- ##
==========================================
+ Coverage 93.36% 93.59% +0.23% 
==========================================
Files 11 11 Lines 829 859 +30 ==========================================
+ Hits 774 804 +30 
Misses 55 55
Impacted FilesCoverage Δ
watch/watch_test.py97.95% <100%> (+0.59%)⬆️
watch/watch.py100% <100%> (ø)⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9213876...aec1c52. Read the comment docs.

@lichen2013
lichen2013force-pushed the keep_watch branch 2 times, most recently from 48223bf to 4f815d4CompareOctober 17, 2017 08:49
Comment threadwatch/watch.py Outdated
resp.close()
resp.release_conn()

if not keep or self._stop:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will result in all cached event to be delivered again. If we want to reconnect, we should catch the last resourceVersion and pass it to the watch call to make sure we continue receiving new events not old cached events. Also would be nice if we can fix this at root too (find the reason for timeout in http client and fix that). I think the server keeps the connection alive and it is the client that has a pre-defined timeout somewhere.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!
Let me do a little more checks.

@karmabkarmabOct 18, 2017

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for what it's worth, i indeed got this same kind of issue solved using @mbohlool recommendation and this kind of snippet:

DOMAIN="kool.karmalabs.local"
....
resource_version=NonewhileTrue:
ifresource_versionisNone:
stream=watch.Watch().stream(crds.list_cluster_custom_object, DOMAIN, "v1", "guitars")
else:
stream=watch.Watch().stream(crds.list_cluster_custom_object, DOMAIN, "v1", "guitars", resource_version=resource_version)
foreventinstream:
obj=event["object"]
metadata=obj.get("metadata")
resource_version=metadata['resourceVersion']
....

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some updates for the timeout setting:

There are two inputs available in the client can set timeouts:

a) timeout_seconds: This value will not used by client but included in the URL:

https://localhost:6443/api/v1/namespaces/default/pods?labelSelector=app%3Ddemo&timeoutSeconds=100&watch=True.

So, this setting is actually used by server.

b) _request_timeout

This can accept 2 type inputs, int or tuple with length equals to 2, checked at

kubernetes.client.rest.RESTClientObject.request()

The value will eventually set to the socket used for the connection.
b.1) if the input is tuple, the first value will actually been ignored.
b.2) when timeout happens, an exception will be raised, for example:

urllib3.exceptions.ReadTimeoutError: HTTPSConnectionPool(host='localhost', port=6443): Read timed out.

b.3) when the value is not set, the default value is None, socket has no timeout.

https://docs.python.org/2/library/socket.html#socket.getdefaulttimeout

Haven't figure out where/how server sets timeout, but I believe when we leave both timeout settings empty, client will keeps the connection alive.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice update on the timeout. timeout_seconds is what server expect for watch calls and if you don't set it, it won't timeout the connection. There is a hidden timeout on the request that fortunately the generated client don't know about and cannot set.

Even with not setting the timeout, the connection can fail or network can fail and it is a good idea to have this flag if we make it smart enough to continue the watch using resource_version.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you explain a little more about the "There is a hidden timeout on the request that fortunately the generated client don't know about and cannot set". Really courious about this....

@lichen2013lichen2013Oct 26, 2017

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Continue the watch using resource_version updated.
Also, I did a little change. Since we already have "timeout_seconds" to let user set the timeouts, when the value is empty, I suppose this means watch forever, no extra flag is needed.

@lichen2013
lichen2013force-pushed the keep_watch branch 3 times, most recently from 14847ad to ff02e98CompareOctober 26, 2017 08:20
@lichen2013lichen2013 changed the title Add flag to enable keep the watch action working all the timeKeep the watch action working foreverOct 26, 2017
Comment threadwatch/watch.py
resp.close()
resp.release_conn()

if timeouts or self._stop:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What if the user set timeouts but it has not been passed yet?

@lichen2013lichen2013Oct 31, 2017

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm still trying to find the proof that the exit happens we saw at the beginning is caused by the client side.

I do find the flag 'min-request-timeout' in doc kube-apiserver, and it is said that the apiserver actually has a timeout setting by itself:

--min-request-timeout=1800: An optional field indicating the minimum number of seconds a handler must keep a request open before timing it out. Currently only honored by the watch request handler, which picks a randomized value above this number as the connection timeout, to spread out load.

And if it is not set, the default value is 1800:

https://github.com/kubernetes/apiserver/blob/master/pkg/server/config.go#L248

MinRequestTimeout: 1800,

So, base on what I know now: I don't think timeout will happen before the timeouts setting.

@mbohlool

Copy link
Copy Markdown
Contributor

@lichen2013 This looks very good. Only one comment, otherwise good to go.

@mbohlool

Copy link
Copy Markdown
Contributor

@lichen2013 Only remaining item here is to reconnect if the user specified timeout is not passed yet (in addition to the case of not setting timeout which reconnect the watch always). I would want to include this in 4.0 client but that needs to be done soon.

Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@lichen2013@codecov-io@mbohlool@karmab
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' Keep the watch action working forever by lichen2013 · Pull Request #36 · kubernetes-client/python-base · GitHub
Skip to content
This repository was archived by the owner on Mar 13, 2022. It is now read-only.

Keep the watch action working forever - #36

Merged
mbohlool merged 2 commits into
kubernetes-client:masterfrom
lichen2013:keep_watch
Jan 10, 2018
Merged

Keep the watch action working forever#36
mbohlool merged 2 commits into
kubernetes-client:masterfrom
lichen2013:keep_watch

Conversation

@lichen2013

Copy link
Copy Markdown

@codecov-io

codecov-io commented Oct 17, 2017

Copy link
Copy Markdown

Codecov Report

Merging #36 into master will increase coverage by 0.23%.
The diff coverage is 100%.

Impacted file tree graph

@@ Coverage Diff @@## master #36 +/- ##
==========================================
+ Coverage 93.36% 93.59% +0.23% 
==========================================
Files 11 11 Lines 829 859 +30 ==========================================
+ Hits 774 804 +30 
Misses 55 55
Impacted FilesCoverage Δ
watch/watch_test.py97.95% <100%> (+0.59%)⬆️
watch/watch.py100% <100%> (ø)⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9213876...aec1c52. Read the comment docs.

@lichen2013
lichen2013force-pushed the keep_watch branch 2 times, most recently from 48223bf to 4f815d4CompareOctober 17, 2017 08:49
Comment threadwatch/watch.py Outdated
resp.close()
resp.release_conn()

if not keep or self._stop:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will result in all cached event to be delivered again. If we want to reconnect, we should catch the last resourceVersion and pass it to the watch call to make sure we continue receiving new events not old cached events. Also would be nice if we can fix this at root too (find the reason for timeout in http client and fix that). I think the server keeps the connection alive and it is the client that has a pre-defined timeout somewhere.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!
Let me do a little more checks.

@karmabkarmabOct 18, 2017

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for what it's worth, i indeed got this same kind of issue solved using @mbohlool recommendation and this kind of snippet:

DOMAIN="kool.karmalabs.local"
....
resource_version=NonewhileTrue:
ifresource_versionisNone:
stream=watch.Watch().stream(crds.list_cluster_custom_object, DOMAIN, "v1", "guitars")
else:
stream=watch.Watch().stream(crds.list_cluster_custom_object, DOMAIN, "v1", "guitars", resource_version=resource_version)
foreventinstream:
obj=event["object"]
metadata=obj.get("metadata")
resource_version=metadata['resourceVersion']
....

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some updates for the timeout setting:

There are two inputs available in the client can set timeouts:

a) timeout_seconds: This value will not used by client but included in the URL:

https://localhost:6443/api/v1/namespaces/default/pods?labelSelector=app%3Ddemo&timeoutSeconds=100&watch=True.

So, this setting is actually used by server.

b) _request_timeout

This can accept 2 type inputs, int or tuple with length equals to 2, checked at

kubernetes.client.rest.RESTClientObject.request()

The value will eventually set to the socket used for the connection.
b.1) if the input is tuple, the first value will actually been ignored.
b.2) when timeout happens, an exception will be raised, for example:

urllib3.exceptions.ReadTimeoutError: HTTPSConnectionPool(host='localhost', port=6443): Read timed out.

b.3) when the value is not set, the default value is None, socket has no timeout.

https://docs.python.org/2/library/socket.html#socket.getdefaulttimeout

Haven't figure out where/how server sets timeout, but I believe when we leave both timeout settings empty, client will keeps the connection alive.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice update on the timeout. timeout_seconds is what server expect for watch calls and if you don't set it, it won't timeout the connection. There is a hidden timeout on the request that fortunately the generated client don't know about and cannot set.

Even with not setting the timeout, the connection can fail or network can fail and it is a good idea to have this flag if we make it smart enough to continue the watch using resource_version.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you explain a little more about the "There is a hidden timeout on the request that fortunately the generated client don't know about and cannot set". Really courious about this....

@lichen2013lichen2013Oct 26, 2017

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Continue the watch using resource_version updated.
Also, I did a little change. Since we already have "timeout_seconds" to let user set the timeouts, when the value is empty, I suppose this means watch forever, no extra flag is needed.

@lichen2013
lichen2013force-pushed the keep_watch branch 3 times, most recently from 14847ad to ff02e98CompareOctober 26, 2017 08:20
@lichen2013lichen2013 changed the title Add flag to enable keep the watch action working all the timeKeep the watch action working foreverOct 26, 2017
Comment threadwatch/watch.py
resp.close()
resp.release_conn()

if timeouts or self._stop:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What if the user set timeouts but it has not been passed yet?

@lichen2013lichen2013Oct 31, 2017

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm still trying to find the proof that the exit happens we saw at the beginning is caused by the client side.

I do find the flag 'min-request-timeout' in doc kube-apiserver, and it is said that the apiserver actually has a timeout setting by itself:

--min-request-timeout=1800: An optional field indicating the minimum number of seconds a handler must keep a request open before timing it out. Currently only honored by the watch request handler, which picks a randomized value above this number as the connection timeout, to spread out load.

And if it is not set, the default value is 1800:

https://github.com/kubernetes/apiserver/blob/master/pkg/server/config.go#L248

MinRequestTimeout: 1800,

So, base on what I know now: I don't think timeout will happen before the timeouts setting.

@mbohlool

Copy link
Copy Markdown
Contributor

@lichen2013 This looks very good. Only one comment, otherwise good to go.

@mbohlool

Copy link
Copy Markdown
Contributor

@lichen2013 Only remaining item here is to reconnect if the user specified timeout is not passed yet (in addition to the case of not setting timeout which reconnect the watch always). I would want to include this in 4.0 client but that needs to be done soon.

Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@lichen2013@codecov-io@mbohlool@karmab
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Keep the watch action working forever by lichen2013 · Pull Request #36 · kubernetes-client/python-base · GitHub
Skip to content
This repository was archived by the owner on Mar 13, 2022. It is now read-only.

Keep the watch action working forever - #36

Merged
mbohlool merged 2 commits into
kubernetes-client:masterfrom
lichen2013:keep_watch
Jan 10, 2018
Merged

Keep the watch action working forever#36
mbohlool merged 2 commits into
kubernetes-client:masterfrom
lichen2013:keep_watch

Conversation

@lichen2013

Copy link
Copy Markdown

@codecov-io

codecov-io commented Oct 17, 2017

Copy link
Copy Markdown

Codecov Report

Merging #36 into master will increase coverage by 0.23%.
The diff coverage is 100%.

Impacted file tree graph

@@ Coverage Diff @@## master #36 +/- ##
==========================================
+ Coverage 93.36% 93.59% +0.23% 
==========================================
Files 11 11 Lines 829 859 +30 ==========================================
+ Hits 774 804 +30 
Misses 55 55
Impacted FilesCoverage Δ
watch/watch_test.py97.95% <100%> (+0.59%)⬆️
watch/watch.py100% <100%> (ø)⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9213876...aec1c52. Read the comment docs.

@lichen2013
lichen2013force-pushed the keep_watch branch 2 times, most recently from 48223bf to 4f815d4CompareOctober 17, 2017 08:49
Comment threadwatch/watch.py Outdated
resp.close()
resp.release_conn()

if not keep or self._stop:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will result in all cached event to be delivered again. If we want to reconnect, we should catch the last resourceVersion and pass it to the watch call to make sure we continue receiving new events not old cached events. Also would be nice if we can fix this at root too (find the reason for timeout in http client and fix that). I think the server keeps the connection alive and it is the client that has a pre-defined timeout somewhere.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!
Let me do a little more checks.

@karmabkarmabOct 18, 2017

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for what it's worth, i indeed got this same kind of issue solved using @mbohlool recommendation and this kind of snippet:

DOMAIN="kool.karmalabs.local"
....
resource_version=NonewhileTrue:
ifresource_versionisNone:
stream=watch.Watch().stream(crds.list_cluster_custom_object, DOMAIN, "v1", "guitars")
else:
stream=watch.Watch().stream(crds.list_cluster_custom_object, DOMAIN, "v1", "guitars", resource_version=resource_version)
foreventinstream:
obj=event["object"]
metadata=obj.get("metadata")
resource_version=metadata['resourceVersion']
....

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some updates for the timeout setting:

There are two inputs available in the client can set timeouts:

a) timeout_seconds: This value will not used by client but included in the URL:

https://localhost:6443/api/v1/namespaces/default/pods?labelSelector=app%3Ddemo&timeoutSeconds=100&watch=True.

So, this setting is actually used by server.

b) _request_timeout

This can accept 2 type inputs, int or tuple with length equals to 2, checked at

kubernetes.client.rest.RESTClientObject.request()

The value will eventually set to the socket used for the connection.
b.1) if the input is tuple, the first value will actually been ignored.
b.2) when timeout happens, an exception will be raised, for example:

urllib3.exceptions.ReadTimeoutError: HTTPSConnectionPool(host='localhost', port=6443): Read timed out.

b.3) when the value is not set, the default value is None, socket has no timeout.

https://docs.python.org/2/library/socket.html#socket.getdefaulttimeout

Haven't figure out where/how server sets timeout, but I believe when we leave both timeout settings empty, client will keeps the connection alive.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice update on the timeout. timeout_seconds is what server expect for watch calls and if you don't set it, it won't timeout the connection. There is a hidden timeout on the request that fortunately the generated client don't know about and cannot set.

Even with not setting the timeout, the connection can fail or network can fail and it is a good idea to have this flag if we make it smart enough to continue the watch using resource_version.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you explain a little more about the "There is a hidden timeout on the request that fortunately the generated client don't know about and cannot set". Really courious about this....

@lichen2013lichen2013Oct 26, 2017

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Continue the watch using resource_version updated.
Also, I did a little change. Since we already have "timeout_seconds" to let user set the timeouts, when the value is empty, I suppose this means watch forever, no extra flag is needed.

@lichen2013
lichen2013force-pushed the keep_watch branch 3 times, most recently from 14847ad to ff02e98CompareOctober 26, 2017 08:20
@lichen2013lichen2013 changed the title Add flag to enable keep the watch action working all the timeKeep the watch action working foreverOct 26, 2017
Comment threadwatch/watch.py
resp.close()
resp.release_conn()

if timeouts or self._stop:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What if the user set timeouts but it has not been passed yet?

@lichen2013lichen2013Oct 31, 2017

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm still trying to find the proof that the exit happens we saw at the beginning is caused by the client side.

I do find the flag 'min-request-timeout' in doc kube-apiserver, and it is said that the apiserver actually has a timeout setting by itself:

--min-request-timeout=1800: An optional field indicating the minimum number of seconds a handler must keep a request open before timing it out. Currently only honored by the watch request handler, which picks a randomized value above this number as the connection timeout, to spread out load.

And if it is not set, the default value is 1800:

https://github.com/kubernetes/apiserver/blob/master/pkg/server/config.go#L248

MinRequestTimeout: 1800,

So, base on what I know now: I don't think timeout will happen before the timeouts setting.

@mbohlool

Copy link
Copy Markdown
Contributor

@lichen2013 This looks very good. Only one comment, otherwise good to go.

@mbohlool

Copy link
Copy Markdown
Contributor

@lichen2013 Only remaining item here is to reconnect if the user specified timeout is not passed yet (in addition to the case of not setting timeout which reconnect the watch always). I would want to include this in 4.0 client but that needs to be done soon.

Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@lichen2013@codecov-io@mbohlool@karmab
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Keep the watch action working forever by lichen2013 · Pull Request #36 · kubernetes-client/python-base · GitHub
Skip to content
This repository was archived by the owner on Mar 13, 2022. It is now read-only.

Keep the watch action working forever - #36

Merged
mbohlool merged 2 commits into
kubernetes-client:masterfrom
lichen2013:keep_watch
Jan 10, 2018
Merged

Keep the watch action working forever#36
mbohlool merged 2 commits into
kubernetes-client:masterfrom
lichen2013:keep_watch

Conversation

@lichen2013

Copy link
Copy Markdown

@codecov-io

codecov-io commented Oct 17, 2017

Copy link
Copy Markdown

Codecov Report

Merging #36 into master will increase coverage by 0.23%.
The diff coverage is 100%.

Impacted file tree graph

@@ Coverage Diff @@## master #36 +/- ##
==========================================
+ Coverage 93.36% 93.59% +0.23% 
==========================================
Files 11 11 Lines 829 859 +30 ==========================================
+ Hits 774 804 +30 
Misses 55 55
Impacted FilesCoverage Δ
watch/watch_test.py97.95% <100%> (+0.59%)⬆️
watch/watch.py100% <100%> (ø)⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9213876...aec1c52. Read the comment docs.

@lichen2013
lichen2013force-pushed the keep_watch branch 2 times, most recently from 48223bf to 4f815d4CompareOctober 17, 2017 08:49
Comment threadwatch/watch.py Outdated
resp.close()
resp.release_conn()

if not keep or self._stop:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will result in all cached event to be delivered again. If we want to reconnect, we should catch the last resourceVersion and pass it to the watch call to make sure we continue receiving new events not old cached events. Also would be nice if we can fix this at root too (find the reason for timeout in http client and fix that). I think the server keeps the connection alive and it is the client that has a pre-defined timeout somewhere.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!
Let me do a little more checks.

@karmabkarmabOct 18, 2017

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for what it's worth, i indeed got this same kind of issue solved using @mbohlool recommendation and this kind of snippet:

DOMAIN="kool.karmalabs.local"
....
resource_version=NonewhileTrue:
ifresource_versionisNone:
stream=watch.Watch().stream(crds.list_cluster_custom_object, DOMAIN, "v1", "guitars")
else:
stream=watch.Watch().stream(crds.list_cluster_custom_object, DOMAIN, "v1", "guitars", resource_version=resource_version)
foreventinstream:
obj=event["object"]
metadata=obj.get("metadata")
resource_version=metadata['resourceVersion']
....

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some updates for the timeout setting:

There are two inputs available in the client can set timeouts:

a) timeout_seconds: This value will not used by client but included in the URL:

https://localhost:6443/api/v1/namespaces/default/pods?labelSelector=app%3Ddemo&timeoutSeconds=100&watch=True.

So, this setting is actually used by server.

b) _request_timeout

This can accept 2 type inputs, int or tuple with length equals to 2, checked at

kubernetes.client.rest.RESTClientObject.request()

The value will eventually set to the socket used for the connection.
b.1) if the input is tuple, the first value will actually been ignored.
b.2) when timeout happens, an exception will be raised, for example:

urllib3.exceptions.ReadTimeoutError: HTTPSConnectionPool(host='localhost', port=6443): Read timed out.

b.3) when the value is not set, the default value is None, socket has no timeout.

https://docs.python.org/2/library/socket.html#socket.getdefaulttimeout

Haven't figure out where/how server sets timeout, but I believe when we leave both timeout settings empty, client will keeps the connection alive.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice update on the timeout. timeout_seconds is what server expect for watch calls and if you don't set it, it won't timeout the connection. There is a hidden timeout on the request that fortunately the generated client don't know about and cannot set.

Even with not setting the timeout, the connection can fail or network can fail and it is a good idea to have this flag if we make it smart enough to continue the watch using resource_version.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you explain a little more about the "There is a hidden timeout on the request that fortunately the generated client don't know about and cannot set". Really courious about this....

@lichen2013lichen2013Oct 26, 2017

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Continue the watch using resource_version updated.
Also, I did a little change. Since we already have "timeout_seconds" to let user set the timeouts, when the value is empty, I suppose this means watch forever, no extra flag is needed.

@lichen2013
lichen2013force-pushed the keep_watch branch 3 times, most recently from 14847ad to ff02e98CompareOctober 26, 2017 08:20
@lichen2013lichen2013 changed the title Add flag to enable keep the watch action working all the timeKeep the watch action working foreverOct 26, 2017
Comment threadwatch/watch.py
resp.close()
resp.release_conn()

if timeouts or self._stop:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What if the user set timeouts but it has not been passed yet?

@lichen2013lichen2013Oct 31, 2017

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm still trying to find the proof that the exit happens we saw at the beginning is caused by the client side.

I do find the flag 'min-request-timeout' in doc kube-apiserver, and it is said that the apiserver actually has a timeout setting by itself:

--min-request-timeout=1800: An optional field indicating the minimum number of seconds a handler must keep a request open before timing it out. Currently only honored by the watch request handler, which picks a randomized value above this number as the connection timeout, to spread out load.

And if it is not set, the default value is 1800:

https://github.com/kubernetes/apiserver/blob/master/pkg/server/config.go#L248

MinRequestTimeout: 1800,

So, base on what I know now: I don't think timeout will happen before the timeouts setting.

@mbohlool

Copy link
Copy Markdown
Contributor

@lichen2013 This looks very good. Only one comment, otherwise good to go.

@mbohlool

Copy link
Copy Markdown
Contributor

@lichen2013 Only remaining item here is to reconnect if the user specified timeout is not passed yet (in addition to the case of not setting timeout which reconnect the watch always). I would want to include this in 4.0 client but that needs to be done soon.

Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@lichen2013@codecov-io@mbohlool@karmab
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); Keep the watch action working forever by lichen2013 · Pull Request #36 · kubernetes-client/python-base · GitHub
Skip to content
This repository was archived by the owner on Mar 13, 2022. It is now read-only.

Keep the watch action working forever - #36

Merged
mbohlool merged 2 commits into
kubernetes-client:masterfrom
lichen2013:keep_watch
Jan 10, 2018
Merged

Keep the watch action working forever#36
mbohlool merged 2 commits into
kubernetes-client:masterfrom
lichen2013:keep_watch

Conversation

@lichen2013

Copy link
Copy Markdown

@codecov-io

codecov-io commented Oct 17, 2017

Copy link
Copy Markdown

Codecov Report

Merging #36 into master will increase coverage by 0.23%.
The diff coverage is 100%.

Impacted file tree graph

@@ Coverage Diff @@## master #36 +/- ##
==========================================
+ Coverage 93.36% 93.59% +0.23% 
==========================================
Files 11 11 Lines 829 859 +30 ==========================================
+ Hits 774 804 +30 
Misses 55 55
Impacted FilesCoverage Δ
watch/watch_test.py97.95% <100%> (+0.59%)⬆️
watch/watch.py100% <100%> (ø)⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9213876...aec1c52. Read the comment docs.

@lichen2013
lichen2013force-pushed the keep_watch branch 2 times, most recently from 48223bf to 4f815d4CompareOctober 17, 2017 08:49
Comment threadwatch/watch.py Outdated
resp.close()
resp.release_conn()

if not keep or self._stop:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will result in all cached event to be delivered again. If we want to reconnect, we should catch the last resourceVersion and pass it to the watch call to make sure we continue receiving new events not old cached events. Also would be nice if we can fix this at root too (find the reason for timeout in http client and fix that). I think the server keeps the connection alive and it is the client that has a pre-defined timeout somewhere.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!
Let me do a little more checks.

@karmabkarmabOct 18, 2017

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for what it's worth, i indeed got this same kind of issue solved using @mbohlool recommendation and this kind of snippet:

DOMAIN="kool.karmalabs.local"
....
resource_version=NonewhileTrue:
ifresource_versionisNone:
stream=watch.Watch().stream(crds.list_cluster_custom_object, DOMAIN, "v1", "guitars")
else:
stream=watch.Watch().stream(crds.list_cluster_custom_object, DOMAIN, "v1", "guitars", resource_version=resource_version)
foreventinstream:
obj=event["object"]
metadata=obj.get("metadata")
resource_version=metadata['resourceVersion']
....

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some updates for the timeout setting:

There are two inputs available in the client can set timeouts:

a) timeout_seconds: This value will not used by client but included in the URL:

https://localhost:6443/api/v1/namespaces/default/pods?labelSelector=app%3Ddemo&timeoutSeconds=100&watch=True.

So, this setting is actually used by server.

b) _request_timeout

This can accept 2 type inputs, int or tuple with length equals to 2, checked at

kubernetes.client.rest.RESTClientObject.request()

The value will eventually set to the socket used for the connection.
b.1) if the input is tuple, the first value will actually been ignored.
b.2) when timeout happens, an exception will be raised, for example:

urllib3.exceptions.ReadTimeoutError: HTTPSConnectionPool(host='localhost', port=6443): Read timed out.

b.3) when the value is not set, the default value is None, socket has no timeout.

https://docs.python.org/2/library/socket.html#socket.getdefaulttimeout

Haven't figure out where/how server sets timeout, but I believe when we leave both timeout settings empty, client will keeps the connection alive.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice update on the timeout. timeout_seconds is what server expect for watch calls and if you don't set it, it won't timeout the connection. There is a hidden timeout on the request that fortunately the generated client don't know about and cannot set.

Even with not setting the timeout, the connection can fail or network can fail and it is a good idea to have this flag if we make it smart enough to continue the watch using resource_version.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you explain a little more about the "There is a hidden timeout on the request that fortunately the generated client don't know about and cannot set". Really courious about this....

@lichen2013lichen2013Oct 26, 2017

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Continue the watch using resource_version updated.
Also, I did a little change. Since we already have "timeout_seconds" to let user set the timeouts, when the value is empty, I suppose this means watch forever, no extra flag is needed.

@lichen2013
lichen2013force-pushed the keep_watch branch 3 times, most recently from 14847ad to ff02e98CompareOctober 26, 2017 08:20
@lichen2013lichen2013 changed the title Add flag to enable keep the watch action working all the timeKeep the watch action working foreverOct 26, 2017
Comment threadwatch/watch.py
resp.close()
resp.release_conn()

if timeouts or self._stop:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What if the user set timeouts but it has not been passed yet?

@lichen2013lichen2013Oct 31, 2017

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm still trying to find the proof that the exit happens we saw at the beginning is caused by the client side.

I do find the flag 'min-request-timeout' in doc kube-apiserver, and it is said that the apiserver actually has a timeout setting by itself:

--min-request-timeout=1800: An optional field indicating the minimum number of seconds a handler must keep a request open before timing it out. Currently only honored by the watch request handler, which picks a randomized value above this number as the connection timeout, to spread out load.

And if it is not set, the default value is 1800:

https://github.com/kubernetes/apiserver/blob/master/pkg/server/config.go#L248

MinRequestTimeout: 1800,

So, base on what I know now: I don't think timeout will happen before the timeouts setting.

@mbohlool

Copy link
Copy Markdown
Contributor

@lichen2013 This looks very good. Only one comment, otherwise good to go.

@mbohlool

Copy link
Copy Markdown
Contributor

@lichen2013 Only remaining item here is to reconnect if the user specified timeout is not passed yet (in addition to the case of not setting timeout which reconnect the watch always). I would want to include this in 4.0 client but that needs to be done soon.

Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@lichen2013@codecov-io@mbohlool@karmab